瀏覽代碼

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
Drashna Jaelre 6 年之前
父節點
當前提交
b91dfa04e3

+ 27 - 0
.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.

+ 15 - 0
.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. 

+ 7 - 0
.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. 

+ 22 - 0
.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. 

+ 43 - 0
docs/support.md

@@ -0,0 +1,43 @@
+# Support
+
+If you need help with something, the best place to get quick support is going to be on our [Discord Server](https://discord.gg/Uq7gcHh).  There is usually somebody online, and there are a bunch of very helpful people there.
+
+Don't forget to read our [Code of Conduct](https://qmk.fm/coc/).
+
+## Help! I don't know where to start! 
+
+If this is the case, then you should start with our [Newbs Guide](https://docs.qmk.fm/#/newbs). There is a lot of great info there, and that should cover everything you need to get started.
+
+If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there. 
+
+## Help! I'm having issues flashing!
+
+First, head to the [Compiling/Flashing FAQ Page](https://docs.qmk.fm/#/faq_build). There is a good deal of info there, and you'll find a bunch of solutions to common issues there. 
+
+## Help, I have an issue that isn't covered by the links above
+
+Okay, that's fine. Then please check the [open issues in our GitHub](https://github.com/qmk/qmk_firmware/issues) to see if somebody is experiencing the same thing (make sure it's not just similar, but actually the same).  
+
+If you can't find anything, then please open a [new issue](https://github.com/qmk/qmk_firmware/issues)!
+
+## What if I found a bug? 
+
+Then please open an issue, and if you know how to fix it, open up a Pull Request on GitHub with the fix.
+
+## But `git` and `GitHub` are intimidating! 
+
+Don't worry, we have some pretty nice [Guidelines](https://docs.qmk.fm/#/newbs_best_practices) on how to start using `git` and GitHub to make things easier to develop. 
+
+Additionally, you can find additional `git` and GitHub related links [here](https://docs.qmk.fm/#/newbs_learn_more_resources).
+
+## I have a Keyboard that I want to add support for
+
+Awesome! Open up a Pull Request for it. We'll review the code, and merge it!  
+
+### What if I want to do brand it with `QMK`? 
+
+That's amazing! We would love to assist you with that! 
+
+In fact, we have a [whol page](https://qmk.fm/powered/) dedicated to adding QMK Branding to your page and keyboard. This covers pretty much everything you need (knowledge and images) to officially support QMK.
+
+If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh).