diff options
-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 | ||||
-rw-r--r-- | docs/support.md | 43 |
5 files changed, 114 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. | ||
diff --git a/docs/support.md b/docs/support.md new file mode 100644 index 000000000..28894c2c3 --- /dev/null +++ b/docs/support.md | |||
@@ -0,0 +1,43 @@ | |||
1 | # Support | ||
2 | |||
3 | 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. | ||
4 | |||
5 | Don't forget to read our [Code of Conduct](https://qmk.fm/coc/). | ||
6 | |||
7 | ## Help! I don't know where to start! | ||
8 | |||
9 | 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. | ||
10 | |||
11 | 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. | ||
12 | |||
13 | ## Help! I'm having issues flashing! | ||
14 | |||
15 | 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. | ||
16 | |||
17 | ## Help, I have an issue that isn't covered by the links above | ||
18 | |||
19 | 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). | ||
20 | |||
21 | If you can't find anything, then please open a [new issue](https://github.com/qmk/qmk_firmware/issues)! | ||
22 | |||
23 | ## What if I found a bug? | ||
24 | |||
25 | Then please open an issue, and if you know how to fix it, open up a Pull Request on GitHub with the fix. | ||
26 | |||
27 | ## But `git` and `GitHub` are intimidating! | ||
28 | |||
29 | 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. | ||
30 | |||
31 | Additionally, you can find additional `git` and GitHub related links [here](https://docs.qmk.fm/#/newbs_learn_more_resources). | ||
32 | |||
33 | ## I have a Keyboard that I want to add support for | ||
34 | |||
35 | Awesome! Open up a Pull Request for it. We'll review the code, and merge it! | ||
36 | |||
37 | ### What if I want to do brand it with `QMK`? | ||
38 | |||
39 | That's amazing! We would love to assist you with that! | ||
40 | |||
41 | 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. | ||
42 | |||
43 | If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh). | ||