summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/blank.md5
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md31
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md19
-rw-r--r--.github/ISSUE_TEMPLATE/other_issues.md9
4 files changed, 64 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md
new file mode 100644
index 0000000000..50a32034d6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/blank.md
@@ -0,0 +1,5 @@
+---
+name: Blank issue
+about: If you're 100% sure that you don't need one of the other issue templates, use this one instead.
+
+---
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000000..a4f90389b0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve the QMK Firmware
+---
+<!-- Provide a general summary of the bug in the Title above -->
+
+<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+**Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**System Information**
+ - Keyboard:
+ - Revision (if applicable):
+ - Operating System:
+ - avr-gcc version:
+<!-- Run `avr-gcc --version` to find out -->
+ - arm gcc version:
+<!-- Run `arm-none-eabi-gcc --version` to find out -->
+ - QMK Firmware version:
+<!-- You can run `git describe --abbrev=0 --tags` to find this out -->
+ - Any keyboard related software installed?
+ - [ ] Auto Hot Key
+ - [ ] Karabiner
+ - [ ] Other
+
+**Additional context**
+
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000000..c9198adff2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a new feature or changes to existing features
+---
+<!--- Provide a general summary of the changes you want in the Title above -->
+
+<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+## Feature Request Type
+
+- [ ] Core Functionality
+- [ ] Add-on hardware support (e.g. 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. Additional information (such as links to spec sheets, licensing info, other related issues or PR's, etc) would be helpful. -->
diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md
new file mode 100644
index 0000000000..5f3e986cc4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/other_issues.md
@@ -0,0 +1,9 @@
+---
+name: Other issues
+about: Anything else that doesn't fall into the above categories.
+---
+<!--- Provide a general summary of the changes you want in the Title above -->
+
+<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+<!-- Please check https://docs.qmk.fm/#/support for additional resources first. If that doesn't answer your question, check the bug report option, as that may be more appropriate. -->