From ed7861ec12e591ada4ccfbea80edd570b1a4333d Mon Sep 17 00:00:00 2001 From: lm41 Date: Fri, 12 Jan 2024 02:04:58 +0100 Subject: [PATCH] Add issue forms --- .github/ISSUE_TEMPLATE/bug_report.md | 34 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/crash_report.md | 28 ---------- .github/ISSUE_TEMPLATE/crash_report.yml | 38 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 22 ++++++++ 6 files changed, 124 insertions(+), 80 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/crash_report.md create mode 100644 .github/ISSUE_TEMPLATE/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/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8e671dfe..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help FlorisBoard improve -title: '' -labels: bug -assignees: '' - ---- - - - -#### Short description -Describe the bug in a short but concise way. - -#### Steps to reproduce -1. Go to '…' -2. Click on '…' -3. Scroll down to '…' -4. See error - -#### Environment information -- FlorisBoard Version: -- Install Source: -- Device: -- Android: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..cba48a3c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug Report +description: Create a report to help FlorisBoard improve +labels: + - "bug" +body: + - type: markdown + attributes: + value: | + Thank you for your help in making FlorisBoard better! + Guide to a good bug-report: + • Please search existing bug/crash reports reports to avoid creating duplicates. + • Give your bug report a good name (no generics like "Error" or "Crash"), so others can easily identify the topic of your issue. + • Describe the bug in a short but concise way. + • If you have a screenshot or screen recording of the bug, link them at the end of this issue. + • Also make sure to fill out the environment information. This info is valuable when trying to fix your described bug. + - type: textarea + id: description + attributes: + label: Short description + description: Describe the bug in a short but concise way. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + value: | + 1. Go to '…' + 2. Click on '…' + 3. Scroll down to '…' + 4. See error + validations: + required: true + - type: input + id: florisversion + attributes: + label: FlorisBoard Version + placeholder: e.g. 0.X.X + validations: + required: true + - type: dropdown + id: installsource + attributes: + label: Install Source + options: + - Google PlayStore + - F-Droid + - GitHub + validations: + required: true + - type: input + id: device + attributes: + label: Device + placeholder: e.g. OnePlus 7T + validations: + required: true + - type: input + id: androidversion + attributes: + label: Android + placeholder: e.g. 10, Stock + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/crash_report.md b/.github/ISSUE_TEMPLATE/crash_report.md deleted file mode 100644 index 6720f275..00000000 --- a/.github/ISSUE_TEMPLATE/crash_report.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Crash report -about: Create a report with a generated crash log attached to help FlorisBoard improve -title: '' -labels: bug -assignees: '' - ---- - - - -#### Short description -Describe what you were doing that could've led to the crash. - -#### Steps to reproduce -1. Go to '…' -2. Click on '…' -3. Scroll down to '…' -4. See crash - - diff --git a/.github/ISSUE_TEMPLATE/crash_report.yml b/.github/ISSUE_TEMPLATE/crash_report.yml new file mode 100644 index 00000000..a58ffb86 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash_report.yml @@ -0,0 +1,38 @@ +name: Crash report +description: Create a report with a generated crash log attached to help FlorisBoard improve +labels: + - "bug" +body: + - type: markdown + attributes: + value: | + Thank you for your help in making FlorisBoard better! + Guide to a good crash-report: + • Please search existing bug/crash reports to avoid creating duplicates. + • Give your crash report a good name (no generics like "Error" or "Crash"), so others can easily identify the topic of your issue. + • Describe what you were doing what could've led to the crash and whether the crash is random or reproducible. + - type: textarea + id: description + attributes: + label: Short description + description: Describe the bug in a short but concise way. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + value: | + 1. Go to '…' + 2. Click on '…' + 3. Scroll down to '…' + 4. See crash + validations: + required: true + - type: textarea + id: crashlog + attributes: + label: Crash log + description: Paste the generated crash log below + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5d4bbdf0..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Feature request / Suggestion -about: Suggest an idea for this project -title: '' -labels: proposal -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..7c0386e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,22 @@ +name: Feature request / Suggestion +description: Suggest an idea for this project +labels: + - "proposal" +body: + - type: markdown + attributes: + value: | + Thank you for your help in making FlorisBoard better! + + Guide to a good feature-request: + • Please search existing proposals to avoid creating duplicates. + • If you have multiple ideas which are not directly connected to other, file a new issue for each idea. This makes it easier to implement your proposals. + • Describe your idea in a short but concise way. + • If you have any examples, e.g. screenshots or other keyboards have the proposed feature implemented, feel free to post them after your description. + - type: textarea + id: feature + attributes: + label: Feature idea + description: Please explain your idea in a precise way. + validations: + required: true