Add support for PR and Issue templates to QMK_firmware GitHub (#4494)
* 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 * Minor tweaks * More minor tweaks * Spleeling fix Co-Authored-By: drashna <drashna@live.com> * CapiTALization fIXes Co-Authored-By: drashna <drashna@live.com> * Use new issue URL Co-Authored-By: drashna <drashna@live.com> * Add blanck issue template * Update the PR template * Formatting and additional changes * Update docs/support.md Co-Authored-By: drashna <drashna@live.com>clockworkpi 0.6.200
parent
3e698a54ea
commit
2ad2b73d68
@ -0,0 +1,5 @@ |
|||||||
|
--- |
||||||
|
name: Blank issue |
||||||
|
about: If you're 100% sure that you don't need one of the other issue templates, use this one instead. |
||||||
|
|
||||||
|
--- |
@ -0,0 +1,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 --> |
||||||
|
|
||||||
|
<!-- 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. --> |
||||||
|
|
||||||
|
**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. --> |
@ -0,0 +1,19 @@ |
|||||||
|
--- |
||||||
|
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 --> |
||||||
|
|
||||||
|
<!-- 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. --> |
||||||
|
|
||||||
|
## Feature Request Type |
||||||
|
|
||||||
|
- [ ] Core Functionality |
||||||
|
- [ ] Add-on hardware support (e.g. audio, RGB, OLED screen, etc.) |
||||||
|
- [ ] Alteration (enhancement/optimization) of existing Feature(s) |
||||||
|
- [ ] New behavior |
||||||
|
|
||||||
|
## 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. --> |
@ -0,0 +1,9 @@ |
|||||||
|
--- |
||||||
|
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 --> |
||||||
|
|
||||||
|
<!-- 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. --> |
||||||
|
|
||||||
|
<!-- 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. --> |
@ -0,0 +1,32 @@ |
|||||||
|
<!--- 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. --> |
||||||
|
|
||||||
|
## 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: --> |
||||||
|
- [ ] Core |
||||||
|
- [ ] Bugfix |
||||||
|
- [ ] New Feature |
||||||
|
- [ ] Enhancement/Optimization |
||||||
|
- [ ] Keyboard (addition or update) |
||||||
|
- [ ] Keymap/Layout/Userspace (addition or update) |
||||||
|
- [ ] Documentation |
||||||
|
|
||||||
|
|
||||||
|
## Issues Fixed or Closed by this PR |
||||||
|
|
||||||
|
* |
||||||
|
|
||||||
|
## 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 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). |
@ -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/new)! |
||||||
|
|
||||||
|
## What if I found a bug? |
||||||
|
|
||||||
|
Then please open an [issue](https://github.com/qmk/qmk_firmware/issues/new), 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 [whole 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). |
Loading…
Reference in new issue