From c62afa2e12e651e2711cb35c038ee41d1262d114 Mon Sep 17 00:00:00 2001 From: Miguel Angel Mulero Martinez Date: Thu, 20 Jan 2022 09:48:09 +0100 Subject: [PATCH] Move GitHub issues to forms --- .github/ISSUE_TEMPLATE/feature-request.md | 21 ----- .github/ISSUE_TEMPLATE/feature-request.yml | 36 +++++++++ .github/ISSUE_TEMPLATE/firmware-bug-report.md | 37 --------- .../ISSUE_TEMPLATE/firmware-bug-report.yml | 77 +++++++++++++++++++ .github/workflows/issues.yml | 22 ------ 5 files changed, 113 insertions(+), 80 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/firmware-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/firmware-bug-report.yml delete mode 100644 .github/workflows/issues.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index c31f59a15..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for for a new feature for Betaflight -labels: "Template: Feature Request" ---- - - - - -### Is your feature request related to a problem? Please describe. - - -### Describe the solution you'd like - - -### Describe alternatives you've considered - - - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..ae3fd727c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest an idea for for a new feature for Betaflight. +labels: [Template: Feature Request] +body: + + - type: markdown + attributes: + value: | + **Please note that feature requests are not 'fire and forget'.** + It is a lot more likely that the feature you would like to have will be implemented if you keep watching your feature request, and provide more details to developers looking into implementing your feature, and help them with testing. + + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. + validations: + required: true + + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + + - type: textarea + attributes: + label: Other information + description: Add any other context or screenshots about the feature request that you think might be relevant here. diff --git a/.github/ISSUE_TEMPLATE/firmware-bug-report.md b/.github/ISSUE_TEMPLATE/firmware-bug-report.md deleted file mode 100644 index 40ecfc610..000000000 --- a/.github/ISSUE_TEMPLATE/firmware-bug-report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Firmware Bug Report -about: Create a report to help us fix bugs in the Betaflight firmware -labels: "Template: Bug" ---- - - -### Describe the bug - - -### To Reproduce - - -### Expected behavior - - -### Flight controller configuration - -``` -PASTE THE OUTPUT OF 'diff' HERE -``` -``` -PASTE THE OUTPUT OF 'resource show all' HERE -``` - -### Setup / Versions - - - Flight controller: - - - Other components: - - - How are the different components wired up: - - - diff --git a/.github/ISSUE_TEMPLATE/firmware-bug-report.yml b/.github/ISSUE_TEMPLATE/firmware-bug-report.yml new file mode 100644 index 000000000..c78097f13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/firmware-bug-report.yml @@ -0,0 +1,77 @@ +name: Firmware Bug Report +description: Create a report to help us fix bugs in the Betaflight firmware. +labels: [Template: Bug] +body: + + - type: markdown + attributes: + value: | + # Please fill all the fields with the required information + + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: To Reproduce + description: Steps to reproduce the behavior. + 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: textarea + attributes: + label: Flight controller configuration + description: | + Create a `diff` and post it here in a code block. Put (three backticks) at the start and end of the diff block (instructions on how to do a diff: https://oscarliang.com/use-diff-not-dump-betaflight/). + Use `resource show all` to create a resource allocation list and post it here in a code block. Put (three backticks) at the start and end of the output block. + value: | + ``` + # REPLACE THIS LINE BY THE OUTPUT OF YOUR `diff` + ``` + ``` + # REPLACE THIS LINE BY THE OUTPUT OF YOUR `resource show all` + ``` + validations: + required: true + + - type: markdown + attributes: + value: | + # Setup / Versions + + - type: input + attributes: + label: Flight controller + description: Specify your flight controller model (what type is it, where was it bought from, ...). + validations: + required: true + + - type: textarea + attributes: + label: Other components + description: Specify other components attached to the flight controller (RX, VTX, brand / model for all of them, firmware version where applicable...). + + - type: textarea + attributes: + label: How are the different components wired up + description: Details about how all is wired. + + - type: markdown + attributes: + value: | + # Other information + + - type: textarea + attributes: + label: Add any other context about the problem that you think might be relevant here diff --git a/.github/workflows/issues.yml b/.github/workflows/issues.yml deleted file mode 100644 index 22ef8e95b..000000000 --- a/.github/workflows/issues.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Issues - -on: - issues: - types: [opened, edited] - -jobs: - auto_close_issues: - name: Check if issues follow the templates - runs-on: ubuntu-latest - steps: - - name: Checkout templates - uses: actions/checkout@v2.3.4 - - name: Automatically close issues that don't follow the templates - uses: ergo720/auto-close-issues@v1.0.4 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - issue-close-message: > - @${issue.user.login}: This issue is being automatically closed because it does not follow the template.\n\n - **When you open an issue or feature request you are presented with a template. Follow the guidelines**.\n\n - You can edit your message to fix this and the issue will be automatically reopened. - closed-issues-label: Not following template