From bda42c976267d956ed6003f609f76badf8a217e2 Mon Sep 17 00:00:00 2001 From: Alexander Capehart Date: Thu, 29 Dec 2022 12:17:59 -0700 Subject: [PATCH] info: use new issue forms Use the new issue forms instead of issue templates. --- .github/CONTRIBUTING.md | 5 +- .github/ISSUE_TEMPLATE/bug-crash-report.md | 47 ---------- .github/ISSUE_TEMPLATE/bug-crash-report.yml | 88 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 33 ------- .github/ISSUE_TEMPLATE/feature-request.yml | 57 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 3 +- .../metadata/android/en-US/changelogs/24.txt | 2 +- 7 files changed, 149 insertions(+), 86 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-crash-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-crash-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 32e9ccd9a..76abe25e7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -21,7 +21,7 @@ These should also be logged in the [Issues](https://github.com/OxygenCobalt/Auxi Please keep in mind when requesting a feature: - **Has it already been requested?** Make sure request for this feature is not already here. - **Has it been already added?** Make sure this feature has not already been added in the most recent release. -- **Will it be accepted?** Read the [Accepted Additions and Requests](../info/ADDITIONS.md) in order to see the likelihood that your request will be implemented. +- **Will it be accepted?** Read the [Why Are These Features Missing?](https://github.com/OxygenCobalt/Auxio/wiki/Why-Are-These-Features-Missing%3F) in order to see the likelihood that your request will be implemented. If you do make a request, provide the following: - What is it that you want? @@ -29,7 +29,7 @@ If you do make a request, provide the following: - Why do you think it will benefit everyone's usage of the app? If you have the knowledge, you can also implement the feature yourself and create a [Pull Request](https://github.com/OxygenCobalt/Auxio/pulls), but its recommended that **you create an issue beforehand to give me a heads up.** -Its also recommended that you read about [Auxio's Architecture](../info/ARCHITECTURE.md) as well to make changes better and more efficient. +Its also recommended that you read about [Auxio's Architecture](https://github.com/OxygenCobalt/Auxio/wiki/Architecture) as well to make changes better and more efficient. ## Translations Go to Auxio's weblate project [here](https://hosted.weblate.org/engage/auxio/). @@ -44,4 +44,3 @@ If you have knowledge of Android/Kotlin, feel free to to contribute to the proje - Please ***FULLY TEST*** your changes before creating a PR. Untested code will not be merged. - Java code will **NOT** be accepted. Kotlin only. - Keep your code up the date with the upstream and continue to maintain it after you create the PR. This makes it less of a hassle to merge. -- Make sure you have read about the [Accepted Additions and Requests](../info/ADDITIONS.md) before working on your addition. diff --git a/.github/ISSUE_TEMPLATE/bug-crash-report.md b/.github/ISSUE_TEMPLATE/bug-crash-report.md deleted file mode 100644 index 2c93a498a..000000000 --- a/.github/ISSUE_TEMPLATE/bug-crash-report.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Bug/Crash Report -about: Report an issue with Auxio -title: '' -labels: bug -assignees: '' - ---- - -#### Describe the bug/crash: - - -#### Expected behavior - - -#### Steps To Reproduce the bug/crash: - - -#### Logs/Stack Traces: - - -#### Screenshots: - - -#### Phone Information: - - -#### Due Diligence: -- [ ] I have checked this issue for any duplicates. -- [ ] I have checked for this issue in the [FAQ](https://github.com/OxygenCobalt/Auxio/blob/dev/info/FAQ.md). -- [ ] I have read the [Contribution Guidelines](https://github.com/OxygenCobalt/Auxio/blob/dev/.github/CONTRIBUTING.md). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-crash-report.yml b/.github/ISSUE_TEMPLATE/bug-crash-report.yml new file mode 100644 index 000000000..6f0519f62 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-crash-report.yml @@ -0,0 +1,88 @@ +name: Bug/Crash Report +description: File a bug report +labels: ["bug"] +assignees: + - OxygenCobalt +body: + - type: markdown + attributes: + value: | + Welcome to Auxio's bug report form. + Please note that not every reported issue can be fixed. Well-written bug reports are more likely to be resolved. + - type: textarea + id: desc + attributes: + label: Describe the Bug/Crash + description: Provide a clear and concise description of the issue alongside steps to reproduce it. + placeholder: | + 1. Go to X + 2. Click on Y + 3. Scroll down to Z + 4. See error + validations: + required: true + - type: textarea + id: intended + attributes: + label: Describe the intended behavior + description: Provide a clear and concise descripton of the correct behavior. Include examples from other music players if applicable. + placeholder: Should do X. + validations: + required: true + - type: dropdown + id: android-version + attributes: + label: What android version do you use? + options: + - Android 13 + - Android 12L + - Android 12 + - Android 11 + - Android 10 + - Android 9 (Pie) + - Android 8.1 (Oreo) + - Android 8 (Oreo) + - Android 7 (Nougat) + - Android 6 (Marshmallow) + - Android 5.1 (Lollipop) + - Android 5 (Lollipop) + validations: + required: true + - type: textarea + id: devide-model + attributes: + label: What device model do you use? + description: Include details on OEM Skin or Custom ROM if possible. + placeholder: OnePlus 7T (LineageOS) + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: | + If possible, provide a stack trace or a Logcat. This can help identify the issue. + To take a logcat, you must do the following: + 1. Use a desktop/laptop to download the android platform tools from https://developer.android.com/studio/releases/platform-tools. + 2. Extract the downloaded file to a folder. + 3. Enable USB debugging on your phone [See https://developer.android.com/studio/command-line/adb#Enabling], and then connect your + phone to a laptop. You will get a prompt to "Allow USB debugging" when you run the logcat command. Accept this. + 4. Open up a terminal/command prompt in that folder and run: + - `./adb -d logcat | grep -i "[DWE] Auxio"` in the case of a bug (may require some changes on windows) + - `./adb -d logcat AndroidRuntime:E *:S` in the case of a crash + 5. Copy and paste the output to this area of the issue. + render: shell + - type: checkboxes + id: terms + attributes: + label: Duplicates + description: By submitting this issue, you aknowledge the following + options: + - label: I have checked the [Troubleshooting](https://github.com/OxygenCobalt/Auxio/wiki/Troubleshooting) page. + required: true + - label: I have checked this issue for duplicates. + required: true + - label: I have checked that this issue occurs on the [lastest version](https://github.com/OxygenCobalt/Auxio/releases). + required: true + - label: I agree to the [Contribution Guidelines](https://github.com/OxygenCobalt/Auxio/blob/dev/.github/CONTRIBUTING.md). + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 24e890b14..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Feature Request -about: Propose an idea for Auxio -title: '' -labels: enhancement -assignees: '' - ---- - - - -#### Describe the feature you want to implement: - - -#### Is your feature request related to a problem? Please describe: - - -#### Do other music players handle this? If so, how? - - -#### Why do you think this will improve everyone's usage of Auxio? - - -#### Due Diligence: -- [ ] I have read the [Contribution Guidelines](https://github.com/OxygenCobalt/Auxio/blob/dev/.github/CONTRIBUTING.md). -- [ ] I have read the [Accepted Additions and Requests](https://github.com/OxygenCobalt/Auxio/blob/dev/info/ADDITIONS.md) document. -- [ ] I have checked for this feature in the [FAQ](https://github.com/OxygenCobalt/Auxio/blob/dev/info/FAQ.md). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..2b2c779a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,57 @@ +name: Feature Request +description: Propose new functionality +labels: ["enhancement"] +assignees: + - OxygenCobalt +body: + - type: markdown + attributes: + value: | + Welcome to Auxio's feature request form. + Please note that there have been several major features that Auxio has already **rejected**, due to either technical issues or due to it not being in scope for the app. To ensure that you are not requesting a feature that was already rejected, please read the [Why Are These Features Missing?](https://github.com/OxygenCobalt/Auxio/wiki/Why-Are-These-Features-Missing%3F) page. + - type: textarea + id: desc + attributes: + label: Description + description: Provide a clear and concise description of the feature to implement. + placeholder: I want... + validations: + required: true + - type: textarea + id: problem + attributes: + label: Problem solved + description: Is your feature request related to a problem? Please describe. + placeholder: I'm always frustrated when... + - type: textarea + id: others + attributes: + label: Other implementations + description: How do other music players handle this? Please describe. + placeholder: This music player does... + validations: + required: true + - type: textarea + id: why + attributes: + label: Benefit + description: > + How will this addition benefit **everyone's** usage of Auxio? A convincing argument increases the likelihood + that this feature is accepted. + placeholder: This feature allows... + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Duplicates + description: By submitting this issue, you aknowledge the following + options: + - label: I have checked this feature request for duplicates. + required: true + - label: I have checked that this feature is not implemented in the [lastest version](https://github.com/OxygenCobalt/Auxio/releases). + required: true + - label: I have checked the [Why Are These Features Missing?](https://github.com/OxygenCobalt/Auxio/wiki/Why-Are-These-Features-Missing%3F) page. + required: true + - label: I agree to the [Contribution Guidelines](https://github.com/OxygenCobalt/Auxio/blob/dev/.github/CONTRIBUTING.md). + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1b639fe4b..766444e74 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,6 @@ #### What is it? - [ ] Bugfix (user facing) - [ ] Feature (user facing) -- [ ] Translation to: (user facing) - [ ] Codebase improvement (dev facing) - [ ] Meta improvement to the project (dev facing) @@ -25,4 +24,4 @@ debug.zip #### Due Diligence - [ ] I have read the [Contribution Guidelines](https://github.com/OxygenCobalt/Auxio/blob/dev/.github/CONTRIBUTING.md). -- [ ] I have read the [Accepted additions & Requests](https://github.com/OxygenCobalt/Auxio/blob/dev/info/ADDITIONS.md) document. +- [ ] I have read the [Why Are These Features Missing?](https://github.com/OxygenCobalt/Auxio/wiki/Why-Are-These-Features-Missing%3F) page. \ No newline at end of file diff --git a/fastlane/metadata/android/en-US/changelogs/24.txt b/fastlane/metadata/android/en-US/changelogs/24.txt index 70ea78366..783516f03 100644 --- a/fastlane/metadata/android/en-US/changelogs/24.txt +++ b/fastlane/metadata/android/en-US/changelogs/24.txt @@ -1 +1 @@ -Auxio 3.0.0 massively improves the music library experience, with a new advanced music loader, a new unified artist model, and a new selection system that makes managing your music a breeze. For more information, see https://github.com/OxygenCobalt/Auxio/releases/tag/v3.0.0. \ No newline at end of file +Auxio 3.0.0 massively improves the music library experience, with a new advanced music loader, a new unified artist model, and a new selection system that makes enqueueing music much simpler. For more information, see https://github.com/OxygenCobalt/Auxio/releases/tag/v3.0.0. \ No newline at end of file