diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-11-26 14:35:01 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-26 14:35:01 -0800 |
| commit | b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf (patch) | |
| tree | d103f22a6868c94ea94dc6d740c61d31afefc949 /.github | |
| parent | fe68599a34af5e4f4f905a4127077fa321dbc0de (diff) | |
| download | qmk_firmware-b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf.tar.gz qmk_firmware-b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf.zip | |
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.md | 27 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 15 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/other_issues.md | 7 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 22 |
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 @@ | |||
| 1 | --- | ||
| 2 | name: Bug report | ||
| 3 | about: Create a report to help us improve the QMK Firmware | ||
| 4 | --- | ||
| 5 | |||
| 6 | **Describe the bug** | ||
| 7 | |||
| 8 | A clear and concise description of what the bug is. | ||
| 9 | |||
| 10 | **System Information** | ||
| 11 | - Keyboard: | ||
| 12 | - Revision (if applicable): | ||
| 13 | - Operating System: | ||
| 14 | - avr-gcc version: | ||
| 15 | (Run `avr-gcc --version` to find out) | ||
| 16 | - arm gcc version: | ||
| 17 | (Run `arm-none-eabi-gcc --version` to find out) | ||
| 18 | - QMK Firmware version: | ||
| 19 | (you can run `git describe --abbrev=0 --tags` to find this out) | ||
| 20 | - Any keyboard related software installed? | ||
| 21 | - [ ] Auto Hot Key | ||
| 22 | - [ ] Karabiner | ||
| 23 | - [ ] Other | ||
| 24 | |||
| 25 | **Additional context** | ||
| 26 | |||
| 27 | 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 @@ | |||
| 1 | --- | ||
| 2 | name: Feature request | ||
| 3 | about: Suggest a new feature or changes to existing features | ||
| 4 | |||
| 5 | --- | ||
| 6 | |||
| 7 | ## Feature Request Type | ||
| 8 | |||
| 9 | - [ ] Core Functionality | ||
| 10 | - [ ] Add-on hardware support (eg audio, rgb, oled screen, etc) | ||
| 11 | - [ ] Alteration (enhancement/optimization) of existing Feature(s) | ||
| 12 | - [ ] New behavior | ||
| 13 | |||
| 14 | ## Description | ||
| 15 | 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 @@ | |||
| 1 | --- | ||
| 2 | name: Other issues | ||
| 3 | about: Anything else that doesn't fall into the above categories. | ||
| 4 | |||
| 5 | --- | ||
| 6 | |||
| 7 | 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 @@ | |||
| 1 | ## Code Change Type | ||
| 2 | - [ ] Core | ||
| 3 | - [ ] Feature | ||
| 4 | - [ ] Bugfix | ||
| 5 | - [ ] Keyboard | ||
| 6 | - [ ] Keymap/Layout/Userspace | ||
| 7 | - [ ] Enhancement/Optimization | ||
| 8 | - [ ] Documentation | ||
| 9 | |||
| 10 | ## Description | ||
| 11 | A few sentences describing the overall goals of the pull request's commits. | ||
| 12 | |||
| 13 | ## Todo | ||
| 14 | - [ ] Tests | ||
| 15 | - [ ] Documentation | ||
| 16 | |||
| 17 | ## Issues Fixed or Closed by this PR | ||
| 18 | |||
| 19 | * | ||
| 20 | |||
| 21 | ## Long Description | ||
| 22 | 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. | ||
