Browse Source

Port over Issue templates to new YML format (#1433)

* 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 <who.just.the.doctor@gmail.com>
Co-authored-by: あく <alleteam@gmail.com>
Kowlin 3 years ago
parent
commit
f1cb95655c

+ 46 - 0
.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.

+ 21 - 0
.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.

+ 24 - 0
.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.

+ 0 - 30
.github/ISSUE_TEMPLATE/bug_report.md

@@ -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.

+ 5 - 0
.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.

+ 0 - 12
.github/ISSUE_TEMPLATE/discuss-issue.md

@@ -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

+ 0 - 20
.github/ISSUE_TEMPLATE/feature_request.md

@@ -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.

+ 0 - 10
.github/ISSUE_TEMPLATE/in-progress.md

@@ -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

+ 0 - 10
.github/ISSUE_TEMPLATE/need-help.md

@@ -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