Skip to content

Commit

Permalink
Refactor project and update modules
Browse files Browse the repository at this point in the history
- Refactor workflows
- Bump gradle to 7.4.1
- Update issue template
- Update PULL_REQUEST_TEMPLATE.md
- Delete dependabot.yml
- Update .github
  • Loading branch information
wax911 committed Feb 27, 2023
1 parent 3563bfe commit f1be446
Show file tree
Hide file tree
Showing 53 changed files with 1,162 additions and 757 deletions.
96 changes: 50 additions & 46 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,55 @@
---
title: "[Bug]: "
name: Bug Report
about: Report any issues regarding the project and help us identify bugs quicker

labels: [":bug: bug"]
---

# Issue Guidelines

Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/AniTrend/support-markdown/blob/master/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.

**You may find an answer in already closed issues**:
https://github.com/AniTrend/support-markdown/issues?q=is%3Aissue+is%3Aclosed


## Description Of Bug
<!--- A clear and concise description of what the bug is. -->

__Pages__ with long titles are under the __Tab__ are cropped from start instead of from the end.

**Steps To Reproduce**
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error


## Expected Behaviour
<!--- A clear and concise description of what you expect to happen. -->

Perhaps it would be best if anime/manga titles are not truncated


## Screenshots/Videos
<!--- If applicable, add screenshots to help explain your problem. If none of these are available please remove this section alone -->


## Device & Build Information
<!--- Please provide any relevant information about your device. This is important in case the issue is not reproducible except for under certain conditions. -->

* OS Version: Lollipop 5.0.1
* App Version: 1.2.0
* Phone Model: Xperia SP
* Phone Brand: Sony


## Additional Context
<!--- What are you trying to accomplish? Providing context helps us come up with a solution that is most useful in the real world, also include an logs if you have any in this section -->

I have tested with multiple devices and the issue doesn't seem to be bound to any specific device, OS version or form factor.

I have tested with ......
- type: markdown
attributes:
value: |
# Issue Guidelines

Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.

**You may find an answer in already closed issues**:
https://github.com/AniTrend/support-markdown/issues?q=is%3Aissue+is%3Aclosed

- type: textarea
id: description
attributes:
label: Description of bug
description: A clear and concise description of what the bug is. In other words what is the behaviour
validations:
required: true

- type: textarea
id: expectation
attributes:
label: Expected behavior
description: A clear and concise description of what you expect to happen. This is the intented behaviour
validations:
required: false

- type: textarea
id: context
attributes:
label: Additional context
description: What are you trying to accomplish? Providing context helps us come up with a solution that is most useful in the real world.
validations:
required: false

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: guidelines
attributes:
label: Community guidelines
description: Please take a moment to review our [community guidelines](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md)
options:
- label: I have read the community guidelines
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: AniTrend Community Support
url: https://github.com/orgs/AniTrend/discussions
about: Please ask and answer questions here.
- name: Frequestnly Ased Questions
url: https://docs.anitrend.co/project/
about: Please review the FAQ for commonly asked questions.
62 changes: 36 additions & 26 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,41 @@
---
title: "[Feature]: "
name: Feature Request
about: Got a suggestion? Then this is what you should use

labels: [":star2: enhancement"]
---

# Issue Guidelines

Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/AniTrend/support-markdown/blob/master/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.

**You may find an answer in already closed issues**:
https://github.com/AniTrend/support-markdown/issues?q=is%3Aissue+is%3Aclosed


## Feature Information
<!-- Is your feature request related to a problem? Please describe. -->

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]


## Solution Information
<!-- Describe the solution you'd like -->

A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.


## Additional context
Add any other context or screenshots about the feature request here.
- type: markdown
attributes:
value: |
# Issue Guidelines

Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.

**You may find an answer in already closed issues**:
https://github.com/AniTrend/support-markdown/issues?q=is%3Aissue+is%3Aclosed

- type: textarea
id: information
attributes:
label: Description of bug
description: Is your feature request related to a problem? Please describe.
validations:
required: true

- type: textarea
id: context
attributes:
label: Additional context
description: What are you trying to accomplish? Providing context helps us come up with a solution that is most useful in the real world, also include images or links if you have any in this section
validations:
required: false

- type: checkboxes
id: guidelines
attributes:
label: Community guidelines
description: Please take a moment to review our [community guidelines](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md)
options:
- label: I have read the community guidelines
required: true
41 changes: 30 additions & 11 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,40 @@
---
title: "[Question]: "
name: Question
about: Ask any general question regarding the project, also if you use this if you don't know what category to use

labels: [":grey_question: question"]
---

# Issue Guidelines
- type: markdown
attributes:
value: |
# Issue Guidelines

Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/AniTrend/support-markdown/blob/master/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.
Before opening a new issue, please take a moment to review our [**community guidelines**](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md) to make the contribution process easy and effective for everyone involved.

**You may find an answer in already closed issues**:
https://github.com/AniTrend/support-markdown/issues?q=is%3Aissue+is%3Aclosed
**You may find an answer in already closed issues**:
https://github.com/AniTrend/support-markdown/issues?q=is%3Aissue+is%3Aclosed

## Question
<!-- Clearly and explicitly explain the details about your question -->
I would like to know if... I have also searched in the closed issues and...
- type: textarea
id: question
attributes:
label: Clearly and explicitly explain the details about your question
validations:
required: true

## Additional Context
<!-- Any additional information regarding your question, you may also add screenshots if any under this section -->
- type: textarea
id: context
attributes:
label: Additional context
description: Any additional information regarding your question, you may also add screenshots
validations:
required: false

I am currently using...
- type: checkboxes
id: guidelines
attributes:
label: Community guidelines
description: Please take a moment to review our [community guidelines](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md)
options:
- label: I have read the community guidelines
required: true
30 changes: 11 additions & 19 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pull Request Template

Thank you for contributing! Please take a moment to review our [**contributing guidelines**](https://github.com/AniTrend/support-markdown/blob/master/CONTRIBUTING.md)
Thank you for contributing! Please take a moment to review our [**contributing guidelines**](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md)
to make the process easy and effective for everyone involved.

**Please open an issue** before embarking on any significant pull request, especially those that
Expand All @@ -11,33 +11,25 @@ Before opening a pull request, please ensure:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] You have followed our [**contributing guidelines**](https://github.com/AniTrend/support-markdown/blob/master/CONTRIBUTING.md)
- [ ] double-check your branch is based on `develop` and targets `develop`
- [ ] Pull request has tests
- [ ] Code is well-commented, linted and follows project conventions
- [ ] Documentation is updated (if necessary)
- [ ] Description explains the issue/use-case resolved
- [ ] I did not commit files that are excluded in the .gitignore file (Happens if you stage files with Android Studio)
- You have followed our [**contributing guidelines**](https://github.com/AniTrend/support-markdown/blob/develop/CONTRIBUTING.md)
- Double-check your branch is based on `develop` and targets `develop` (where applicable)
- Pull request has tests (If applicable)
- Code is well-commented, linted and follows project conventions
- Documentation is updated (if necessary)
- Description explains the issue/use-case resolved


## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, tests ran to see how -->
<!--- your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Enhancement (Improve existing functionality)

<!--- Be kind to code reviewers, please try to keep pull requests as small and focused as possible :) -->

**IMPORTANT**: By submitting a patch, you agree to allow the project
owners to license your work under the terms of the [Apache License](https://github.com/AniTrend/support-markdown/blob/develop/LICENSE).
14 changes: 0 additions & 14 deletions .github/dependabot.yml

This file was deleted.

3 changes: 3 additions & 0 deletions .github/pr-labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
feature: 'feature/*'
refactor: ['refactor/*', 'enhancement/*']
hotfix: ['hotfix/*', 'bugfix/*']
50 changes: 50 additions & 0 deletions .github/release-drafter-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name-template: 'v$RESOLVED_VERSION'
tag-template: '$RESOLVED_VERSION'
categories:
- title: '🚀 Features'
labels:
- 'feature'
- title: '🐛 Bug Fixes'
labels:
- 'bugfix'
- 'hotfix'
- title: '🧰 Maintenance'
labels:
- 'refactor'
- title: '📦 Dependencies'
labels:
- 'dependencies'
autolabeler:
- label: 'docs'
files:
- '*.md'
branch:
- '/docs{0,1}\/.+/'
- label: 'dependencies'
branch:
- '/dependencies\/.+/'
- '/renovate\/.+/'
change-template: '- $TITLE by @$AUTHOR in #$NUMBER'
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
version-resolver:
major:
labels:
- 'major'
minor:
labels:
- 'minor'
- 'refactor'
- 'feature'
patch:
labels:
- 'patch'
- 'bugfix'
- 'hotfix'
- 'dependencies'
default: patch
template: |
# What's Changed
$CHANGES
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
25 changes: 25 additions & 0 deletions .github/workflows/android-spotless.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Run spotless check

on:
push:
branches: [ develop ]
pull_request:
branches:
- '*'

jobs:
android-spotless:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: set up JDK 11
uses: actions/setup-java@v3
with:
java-version: '11'
distribution: 'adopt'

- name: Setup Gradle
uses: gradle/gradle-build-action@v2

- name: Run spotless check
run: ./gradlew spotlessCheck
Loading

0 comments on commit f1be446

Please sign in to comment.