summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBrian Choromanski <BrianChoromanski@gmail.com>2022-10-03 21:42:56 -0400
committerGitHub <noreply@github.com>2022-10-04 12:42:56 +1100
commitdc5234746148adf06ef399a50a8ecd1b3f5e999d (patch)
treed2a613dcd5a86dbccb8f116fd38aad87378d085b /.github
parent88046b3ebf2c628abbad501e21ebd99cae8687e4 (diff)
Added new issue templates for feature requests and bug reports (#18576)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md36
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml41
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md24
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml21
4 files changed, 62 insertions, 60 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 81561eaba6..0000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,36 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve QMK Firmware.
-title: "[Bug] "
-labels: bug, help wanted
-assignees: ''
-
----
-
-<!-- Provide a general summary of the bug in the title above. -->
-
-<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
-
-## Describe the Bug
-
-<!-- A clear and concise description of what the bug is. -->
-
-## System Information
-
-**Keyboard:**
-**Revision (if applicable):**
-**Operating system:**
-**`qmk doctor` output:**
-```
-(Paste output here)
-```
-
-**Any keyboard related software installed?**
- - [ ] AutoHotKey (Windows)
- - [ ] Karabiner (macOS)
- - [ ] Other:
-
-## Additional Context
-
-<!-- Add any other relevant information about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..a5d185e1dd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,41 @@
+name: Bug report
+description: Create a report to help us improve QMK Firmware.
+title: "[Bug] "
+labels: ["bug", "help wanted"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Provide a general summary of the bug in the title above.
+ - type: textarea
+ attributes:
+ label: Describe the Bug
+ description: A clear and concise description of what the bug is.
+ - type: input
+ attributes:
+ label: Keyboard Used
+ description: The name of the keyboard from the `make` or `qmk compile`/`qmk flash` commands, eg. `planck/rev6`.
+ - type: input
+ attributes:
+ label: Link to product page (if applicable)
+ - type: input
+ attributes:
+ label: Operating System
+ - type: textarea
+ attributes:
+ label: qmk doctor Output
+ description: Output from running the `qmk doctor` command.
+ render: text
+ - type: checkboxes
+ attributes:
+ label: Is AutoHotKey / Karabiner installed
+ options:
+ - label: AutoHotKey (Windows)
+ - label: Karabiner (macOS)
+ - type: input
+ attributes:
+ label: Other keyboard-related software installed
+ - type: textarea
+ attributes:
+ label: Additional Context
+ description: Add any other relevant information about the problem here. \ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 1876834247..0000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-name: Feature request
-about: Suggest a new feature or changes to existing features.
-title: "[Feature Request] "
-labels: enhancement, help wanted
-assignees: ''
-
----
-
-<!--- Provide a general summary of the changes you want in the title above. -->
-
-<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
-
-## Feature Request Type
-
-- [ ] Core functionality
-- [ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
-- [ ] Alteration (enhancement/optimization) of existing feature(s)
-- [ ] New behavior
-
-## Description
-
-<!-- A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000000..585bcf2e6f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,21 @@
+name: Feature request
+description: Suggest a new feature or changes to existing features.
+title: "[Feature Request] "
+labels: ["enhancement", "help wanted"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Provide a general summary of the changes you want in the title above.
+ - type: checkboxes
+ attributes:
+ label: Feature Request Type
+ options:
+ - label: Core functionality
+ - label: Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
+ - label: Alteration (enhancement/optimization) of existing feature(s)
+ - label: New behavior
+ - type: textarea
+ attributes:
+ label: Description
+ description: A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful. \ No newline at end of file