1
0
Fork 0

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
This commit is contained in:
Drashna Jael're 2018-11-26 14:35:01 -08:00 committed by GitHub
parent fe68599a34
commit b91dfa04e3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 114 additions and 0 deletions

27
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -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.

View file

@ -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.

View file

@ -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.

22
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -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.