From ffbea9ea32760084fdb399a0184a0ec06155095f Mon Sep 17 00:00:00 2001 From: Alexander Bakker Date: Wed, 9 Nov 2022 14:43:20 +0100 Subject: [PATCH] Use the new syntax for GitHub issue forms --- .github/ISSUE_TEMPLATE/bug.md | 34 --------------- .github/ISSUE_TEMPLATE/bug.yml | 78 ++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 7 ++- 3 files changed, 81 insertions(+), 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 7f5edcbe..00000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: "Bug report" -about: "Create a report to help us fix a bug" -labels: bug ---- - - - -###### Info - -* __Version__: -* __Source__: (Google Play/GitHub/F-Droid/?) -* __Vault encrypted__: Yes (with biometric unlock)/Yes/No -* __Device__: -* __Android version and ROM__: - -###### Steps to reproduce - -A detailed list of reproduction steps. - -###### What do you expect to happen? - -... - -###### What happens instead? - -... - -###### Log - -``` -If applicable, paste the debug log here. -``` diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..3e1bb92e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: Create a report to help us fix a bug +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Please read the [bug reports section of the contribution guidelines](https://github.com/beemdevelopment/Aegis/blob/master/CONTRIBUTING.md#bug-reports) before submitting an issue. + - type: input + id: version + attributes: + label: Version + description: Which version of Aegis are you using? + placeholder: "Example: v2.1" + validations: + required: true + - type: dropdown + id: source + attributes: + label: Source + description: Where did you get Aegis from? + options: + - Google Play + - F-Droid + - GitHub + - Other + validations: + required: true + - type: input + id: device + attributes: + label: Device + description: Which device are you using Aegis on? + placeholder: "Example: Pixel 5" + validations: + required: true + - type: input + id: android_version + attributes: + label: Android version + description: Which Android version is running on your device? + placeholder: "Example: Android 13" + validations: + required: true + - type: input + id: rom + attributes: + label: ROM + description: Are you using a custom ROM? If so, which one and which version? If you're using the stock OS that came with your device, you can leave this field empty. + placeholder: "Example: GrapheneOS" + validations: + required: false + - type: textarea + id: reproduction_steps + attributes: + label: Steps to reproduce + description: A detailed list of reproduction steps. + validations: + required: true + - type: textarea + id: expectations + attributes: + label: What do you expect to happen? + validations: + required: true + - type: textarea + id: reality + attributes: + label: What happens instead? + validations: + required: true + - type: textarea + id: log + attributes: + label: Log + description: If applicable, paste the debug log that you captured using ADB here. + validations: + required: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 667db4bc..0c7733c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,10 +30,9 @@ requests. ## Bug reports We use GitHub's issue tracker to track bugs. To make bug reports easier to -follow up on for us, they must follow [the -template](.github/ISSUE_TEMPLATE/bug.md). If a bug report does not follow the -template and does not contain enough information, it will be closed. Duplicate -bug reports receive the same treatment. +follow up on for us, please fill out the form as accurately as possible. If a +bug report does not contain enough information, it will be closed. Duplicate bug +reports receive the same treatment. Please consider trying to find the root cause yourself first and include your analysis of the issue in your report. Perhaps even send us a patch that fixes