From fae81d4f9f260abf3cecb60d1eac72e62aaff022 Mon Sep 17 00:00:00 2001 From: machiav3lli Date: Thu, 31 Oct 2024 02:20:26 +0100 Subject: [PATCH] Update: GH issue and feature request templates --- .github/ISSUE_TEMPLATE/bug-reporting.md | 46 ------------ .github/ISSUE_TEMPLATE/bug_report.yaml | 78 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 45 ------------ .github/ISSUE_TEMPLATE/feature_request.yaml | 57 +++++++++++++++ 5 files changed, 149 insertions(+), 91 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-reporting.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-reporting.md b/.github/ISSUE_TEMPLATE/bug-reporting.md deleted file mode 100644 index 96bd7d92c..000000000 --- a/.github/ISSUE_TEMPLATE/bug-reporting.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Bug Reporting -about: Report a bug in the app's functionality -title: "[Bug] SHORT DESCRIPTION" -labels: '' -assignees: '' - ---- - -**Description** -A clear and concise description of what the bug is. - -**Steps To Reproduce** - -1. ... -2. ... -3. ... -4. Crash, Nothing happens .... - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -Only if there's no clear logs, add screenshots to help explain your problem. - -**System Information(please complete the following information):** - -- Device: -- Android Version: -- ROM: (AOSP, MIUI, OOS...) -- App's Version: - ------------------------------ - -**Additional Notes** - -* If you're on the latest Test version(from the TG-Channel or Matrix-Room) please report there directly, not here. - -* If you're on the latest github version: - - * Please read the [FAQ](https://github.com/NeoApplications/Neo-Backup/blob/master/FAQ.md) first. - * Please read all the open Issues. If one does match yours, leave a comment there if there's some extra information you can provide. - -* If you're not on the latest github version. Update, then make sure that the bug is still there. If it's go further with reporting. - -Thanks for reporting. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..fc60a3d83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,78 @@ +name: Bug Report +description: Report a bug in Neo Backup's functionality +title: "[Bug] " +body: + - type: markdown + attributes: + value: | + **README: Before You Submit Your Issue** + - Issues are not a place to go ask support questions or start discussions. + - Please ask support questions in our [Telegram](https://t.me/neo_backup) or [Matrix](https://matrix.to/#/#neo-backup:matrix.org) groups or start discussions on the [discussions page](https://github.com/NeoApplications/Neo-Backup/discussions). + - type: checkboxes + attributes: + label: Guidelines + description: Please ensure you've completed all of the following. + options: + - label: I have read the [FAQ](https://github.com/NeoApplications/Neo-Backup/blob/master/FAQ.md) and it doesn't cover the issue. + required: true + - label: I have searched the issue tracker for [open](https://github.com/NeoApplications/Neo-Backup/issues) and [closed](https://github.com/NeoApplications/Neo-Backup/issues?q=is%3Aissue+is%3Aclosed) issues that are similar to the feature request I want to file, without success. + required: true + - label: I'm on the latest version. + required: true + - label: I'm not using a test build (alpha/beta/release-candidate). + required: true + - label: This issue contains only one bug. + required: true + - type: textarea + attributes: + label: Describe the bug + description: 'Steps to reproduce the behavior:' + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: input + attributes: + label: Neo Backup's Version + description: Enter the version name on which the bug occurs. + placeholder: 8.0.0 + validations: + required: true + - type: dropdown + attributes: + label: Installation Source + description: Where did you install Neo Backup from? + options: + - Official F-Droid repo + - IzzyOnDroid's repo + - Github/Codeberg/Gitlab releases + - Other… + validations: + required: true + - type: input + attributes: + label: 'Last Known Working Version' + description: What is the last version of Neo Backup this worked on? (If Any) + placeholder: 1.0.0 + - type: textarea + attributes: + label: Relevant information + description: | + Feel free to add any other context or media about the feature request here. + value: | + - Device: + - Android Version: + - ROM: (AOSP, CalyxOS, MIUI, GOS...) + - type: markdown + attributes: + value: | + **Thanks for making us aware of the bug!** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f4ec85330 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Translate Neo Backup + url: https://hosted.weblate.org/engage/neo-backup/ + about: Help translate Neo Backup on Weblate + - name: Matrix Community + url: https://matrix.to/#/#neo-backup:matrix.org + about: 'Join our Matrix community group!' + - name: Telegram Community + url: https://t.me/neo_backup + about: 'Join our Telegram community group!' + - name: Discussions + url: https://github.com/NeoApplications/Neo-Backup/discussions + about: View discussions or start one yourself. But be aware that our Telegram & Matrix groups are the preferred way for discussions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 568a5ab25..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[Feature Request] NAME OF THE FEATURE" -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe it.** -A clear and concise description of what the problem is. - -**Describe the primary solution** -A clear and concise description of what you want to happen. You can also list it in steps. - -**Describe alternative solutions, if any** -A clear and concise description of any alternative solutions or features you've considered. - -**Screenshots** -If you're willing to add demonstrative screenshots, you're welcome to do so. - -**System Information (please complete the following information):** - -- Device: -- Android Version: -- ROM: (AOSP, MIUI, OOS...) -- App Version: - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000..3c0580099 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,57 @@ +name: Feature request +description: Suggest an idea for Neo Backup +title: "[Feature Request] " +body: + - type: markdown + attributes: + value: | + **README: Before You Submit Your Issue** + - Issues are not a place to go ask support questions or start discussions. + - Please ask support questions in our [Telegram](https://t.me/neo_backup) or [Matrix](https://matrix.to/#/#neo-backup:matrix.org) groups or start discussions on the [discussions page](https://github.com/NeoApplications/Neo-Backup/discussions). + - type: checkboxes + attributes: + label: Guidelines + description: Please ensure you've completed all of the following. + options: + - label: I have read the [FAQ](https://github.com/NeoApplications/Neo-Backup/blob/master/FAQ.md) and it doesn't cover my request. + required: true + - label: I have searched the issue tracker for [open](https://github.com/NeoApplications/Neo-Backup/issues) and [closed](https://github.com/NeoApplications/Neo-Backup/issues?q=is%3Aissue+is%3Aclosed) issues that are similar to the feature request I want to file, without success. + required: true + - label: I'm on the latest version. + required: true + - label: I'm not using a test build (alpha/beta/release-candidate). + required: true + - label: This issue contains only one feature request. + required: true + - type: textarea + attributes: + label: Problem Description + description: Please add a clear and concise description of the problem you are seeking to solve with this feature request. + validations: + required: true + - type: textarea + attributes: + label: Proposed Solution + description: Describe the solution you'd like. + validations: + required: true + - type: textarea + attributes: + label: Alternatives Considered + description: Describe alternatives you've considered. + validations: + required: false + - type: textarea + attributes: + label: Relevant information + description: | + Feel free to add any other context or media about the feature request here. + value: | + - Device: + - Android Version: + - ROM: (AOSP, CalyxOS, MIUI, GOS...) + - App's Version: + - type: markdown + attributes: + value: | + **Thanks for contributing ideas!**