aboutsummaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorGravatar Drashna Jaelre <drashna@live.com>2018-11-26 14:35:01 -0800
committerGravatar GitHub <noreply@github.com>2018-11-26 14:35:01 -0800
commitb91dfa04e3bad560fb6fe2360dd51fb95d95fcbf (patch)
treed103f22a6868c94ea94dc6d740c61d31afefc949 /.github
parentfe68599a34af5e4f4f905a4127077fa321dbc0de (diff)
downloadqmk_firmware-b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf.tar.gz
Add support for PR and Issue templates to QMK_firmware GitHub (#4491)
* Add support document * Add Bug Report * Add GitHub Pull Request Template * Feature request issue template * Touch up feature request template * Add 'other issues' template * move support doc
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md27
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md15
-rw-r--r--.github/ISSUE_TEMPLATE/other_issues.md7
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md22
4 files changed, 71 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..ed5d56ce3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve the QMK Firmware
+---
+
+**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 000000000..ac924b3ac
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest a new feature or changes to existing features
+
+---
+
+## 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 sentances 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 000000000..53481f9ab
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/other_issues.md
@@ -0,0 +1,7 @@
+---
+name: Other issues
+about: Anything else that doesn't fall into the above categories.
+
+---
+
+Please check https://docs.qmk.fm/SUPPORT.md for additional resources first. If that doesn't answer your question, check the bug report option, as that may be more appropriate.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..36410da26
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,22 @@
+## Code Change Type
+- [ ] Core
+- [ ] Feature
+- [ ] Bugfix
+- [ ] Keyboard
+- [ ] Keymap/Layout/Userspace
+- [ ] Enhancement/Optimization
+- [ ] Documentation
+
+## Description
+A few sentences describing the overall goals of the pull request's commits.
+
+## Todo
+- [ ] Tests
+- [ ] Documentation
+
+## Issues Fixed or Closed by this PR
+
+*
+
+## Long Description
+If needed, a longer description and a list of changes should be added here to make it clear what exactly this PR's goals are.