From f1cb95655cdb6cb6ca7ea9251f85d79cbc4b1e94 Mon Sep 17 00:00:00 2001 From: Kowlin <10947836+Kowlin@users.noreply.github.com> Date: Mon, 25 Jul 2022 15:11:24 +0200 Subject: [PATCH] Port over Issue templates to new YML format (#1433) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * WIP Push * Add feature request label to template * Punctuation helps * rename feature request and add in enhancement * wording * Add in extra markdown explanations Co-authored-by: SG Co-authored-by: あく --- .github/ISSUE_TEMPLATE/01_bug_report.yml | 46 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02_enhancements.yml | 21 +++++++++ .github/ISSUE_TEMPLATE/03_feature_request.yml | 24 ++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 30 ------------ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/discuss-issue.md | 12 ----- .github/ISSUE_TEMPLATE/feature_request.md | 20 -------- .github/ISSUE_TEMPLATE/in-progress.md | 10 ---- .github/ISSUE_TEMPLATE/need-help.md | 10 ---- 9 files changed, 96 insertions(+), 82 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02_enhancements.yml create mode 100644 .github/ISSUE_TEMPLATE/03_feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/discuss-issue.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/in-progress.md delete mode 100644 .github/ISSUE_TEMPLATE/need-help.md diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml new file mode 100644 index 000000000..4697c0837 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -0,0 +1,46 @@ +name: Bug report +description: File a bug reports regarding the firmware. +labels: ['bug'] +body: +- type: markdown + attributes: + value: | + Thank you for taking the time to fill out an issue, this template is meant for any issues related to the Flipper Zero firmware. + If you require help with the Flipper zero and its firmware, we ask that you join [our forum](https://forum.flipperzero.one) +- type: textarea + id: description + attributes: + label: Desctibe the bug. + description: "A clear and concise description of what the bug is." + validations: + required: true +- type: textarea + id: repro + attributes: + label: Reproduction + description: "How can this bug be reproduced?" + placeholder: | + 1. Switch on... + 2. Press button '....' + 3. Wait for the moon phase + 4. It burns + validations: + required: true +- type: input + id: target + attributes: + label: Target + description: Specify the target + # Target seems to be largely ignored by outside sources. +- type: textarea + id: logs + attributes: + label: Logs + description: Attach your debug logs here + render: Text + # Avoid rendering as Markdown here. +- type: textarea + id: anything-else + attributes: + label: Anything else? + description: Let us know if you have anything else to share. diff --git a/.github/ISSUE_TEMPLATE/02_enhancements.yml b/.github/ISSUE_TEMPLATE/02_enhancements.yml new file mode 100644 index 000000000..1768e193c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_enhancements.yml @@ -0,0 +1,21 @@ +name: Enhancements +description: Suggest improvements for any existing functionality within the firmware. +body: +- type: markdown + attributes: + value: | + Thank you for taking the time to fill out an issue. This template is meant for feature requests and improvements to already existing functionality. + If you require help with the Flipper zero and its firmware, we ask that you join [our forum](https://forum.flipperzero.one) +- type: textarea + id: proposal + attributes: + label: "Describe the enhancement you're suggesting." + description: | + Feel free to describe in as much detail as you wish. + validations: + required: true +- type: textarea + id: anything-else + attributes: + label: Anything else? + description: Let us know if you have anything else to share. diff --git a/.github/ISSUE_TEMPLATE/03_feature_request.yml b/.github/ISSUE_TEMPLATE/03_feature_request.yml new file mode 100644 index 000000000..2af114547 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_feature_request.yml @@ -0,0 +1,24 @@ +name: Feature Request +description: For feature requests regarding the firmware. +labels: ['feature request'] +body: +- type: markdown + attributes: + value: | + Thank you for taking the time to fill out an issue, this template is meant for any feature suggestions. + If you require help with the Flipper zero and its firmware, we ask that you join [our forum](https://forum.flipperzero.one) +- type: textarea + id: proposal + attributes: + label: "Description of the feature you're suggesting." + description: | + Please describe your feature request in as many details as possible. + - Describe what it should do. + - Note whetever it is to extend existing functionality or introduce new functionality. + validations: + required: true +- type: textarea + id: anything-else + attributes: + label: Anything else? + description: Let us know if you have anything else to share. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index cf337499e..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Switch on... -2. Press button '....' -3. Wait for the moon phase -4. It burns - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Logs** -Add debug logs - -**Target** -Specify the target - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..55ff9d29e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Need help? + url: https://forum.flipperzero.one + about: For any question regarding on how to use the Flipper Zero and its firmware. diff --git a/.github/ISSUE_TEMPLATE/discuss-issue.md b/.github/ISSUE_TEMPLATE/discuss-issue.md deleted file mode 100644 index d036533d0..000000000 --- a/.github/ISSUE_TEMPLATE/discuss-issue.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Discuss issue -about: Start discussion about improvements -title: '' -labels: discussion -assignees: '' - ---- - -# What are you want to add or change - -# What questions do you have diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index e301d68ce..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: feature request -assignees: '' - ---- - -**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 [...] - -**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. diff --git a/.github/ISSUE_TEMPLATE/in-progress.md b/.github/ISSUE_TEMPLATE/in-progress.md deleted file mode 100644 index e8cf0332c..000000000 --- a/.github/ISSUE_TEMPLATE/in-progress.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: In progress -about: When you start doing your big deal -title: '' -labels: in progress -assignees: '' - ---- - -Shortly (or not) describe what are you will do diff --git a/.github/ISSUE_TEMPLATE/need-help.md b/.github/ISSUE_TEMPLATE/need-help.md deleted file mode 100644 index c7b1e2863..000000000 --- a/.github/ISSUE_TEMPLATE/need-help.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Need help -about: Ask the community for help if you confused and can't figure out something -title: '' -labels: need help -assignees: '' - ---- - -# Describe you problem here