diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 31 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 16 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/other_issues.md | 6 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 28 |
4 files changed, 42 insertions, 39 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a4f90389b0..3c35416e04 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,30 +2,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 --> +<!-- 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. --> +<!--- 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** +## Describe the Bug <!-- A clear and concise description of what the bug is. --> -**System Information** +## 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 --> + - Operating system: + - AVR GCC version: +<!-- Run `avr-gcc --version` to find this out. --> + - ARM GCC version: +<!-- Run `arm-none-eabi-gcc --version` to find this out. --> - QMK Firmware version: -<!-- You can run `git describe --abbrev=0 --tags` to find this out --> +<!-- Run `git describe --abbrev=0 --tags` to find this out. --> - Any keyboard related software installed? - - [ ] Auto Hot Key + - [ ] AutoHotKey - [ ] Karabiner - - [ ] Other + - [ ] Other: -**Additional context** +## Additional Context -<!-- Add any other context about the problem here. --> +<!-- Add any other relevant information about the problem here. --> diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c9198adff2..01aeb26cec 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,18 +2,18 @@ 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 --> +<!--- 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. --> +<!--- 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 (e.g. audio, RGB, OLED screen, etc.) -- [ ] Alteration (enhancement/optimization) of existing Feature(s) +- [ ] Core functionality +- [ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.) +- [ ] Alteration (enhancement/optimization) of existing feature(s) - [ ] New behavior -## Description +## 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. --> +<!-- 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/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md index 5f3e986cc4..7c4891ac31 100644 --- a/.github/ISSUE_TEMPLATE/other_issues.md +++ b/.github/ISSUE_TEMPLATE/other_issues.md @@ -2,8 +2,8 @@ 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 --> +<!--- 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. --> +<!--- Anything on lines wrapped in comments like these will not show up in the final text. --> -<!-- 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. --> +<!-- Please check https://docs.qmk.fm/#/support for additional resources first. If that doesn't answer your question, choose the bug report template instead, as that may be more appropriate. --> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 05223aa4f6..cbc018ea05 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,32 +1,34 @@ -<!--- Provide a general summary of your changes in the Title above --> +<!--- Provide a general summary of your changes 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. --> +<!--- 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. --> ## Description -<!--- Describe your changes in detail --> -## Types of changes -<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> +<!--- Describe your changes in detail here. --> + +## Types of Changes + +<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply. --> - [ ] Core - [ ] Bugfix -- [ ] New Feature -- [ ] Enhancement/Optimization +- [ ] New feature +- [ ] Enhancement/optimization - [ ] Keyboard (addition or update) -- [ ] Keymap/Layout/Userspace (addition or update) +- [ ] Keymap/layout/userspace (addition or update) - [ ] Documentation - -## Issues Fixed or Closed by this PR +## Issues Fixed or Closed by This PR * -## Checklist: +## Checklist + <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. -- [ ] I have read the **CONTRIBUTING** document. (https://docs.qmk.fm/#/contributing) +- [ ] I have read the [**CONTRIBUTING** document](https://docs.qmk.fm/#/contributing). - [ ] I have added tests to cover my changes. - [ ] I have tested the changes and verified that they work and don't break anything (as well as I can manage). |