diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-12-07 16:51:27 -0800 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2018-12-07 16:51:27 -0800 |
| commit | 2ad2b73d685cf25268fa7d3726f45594edee70c4 (patch) | |
| tree | 23154d07bc716d1160876d03f9abc54e8efdc438 | |
| parent | 3e698a54ea22b12512c9e4f676f7d7363c35832f (diff) | |
| download | qmk_firmware-2ad2b73d685cf25268fa7d3726f45594edee70c4.tar.gz qmk_firmware-2ad2b73d685cf25268fa7d3726f45594edee70c4.zip | |
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>
| -rw-r--r-- | .github/ISSUE_TEMPLATE/blank.md | 5 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 31 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 19 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/other_issues.md | 9 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 32 | ||||
| -rw-r--r-- | docs/_sidebar.md | 1 | ||||
| -rw-r--r-- | docs/_summary.md | 1 | ||||
| -rw-r--r-- | docs/support.md | 43 |
8 files changed, 141 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md new file mode 100644 index 000000000..50a32034d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank.md | |||
| @@ -0,0 +1,5 @@ | |||
| 1 | --- | ||
| 2 | name: Blank issue | ||
| 3 | about: If you're 100% sure that you don't need one of the other issue templates, use this one instead. | ||
| 4 | |||
| 5 | --- | ||
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..a4f90389b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md | |||
| @@ -0,0 +1,31 @@ | |||
| 1 | --- | ||
| 2 | name: Bug report | ||
| 3 | about: Create a report to help us improve the QMK Firmware | ||
| 4 | --- | ||
| 5 | <!-- Provide a general summary of the bug in the Title above --> | ||
| 6 | |||
| 7 | <!-- This template is entirely option and can be removed, but is here to help both you and us. --> | ||
| 8 | <!-- 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. --> | ||
| 9 | |||
| 10 | **Describe the bug** | ||
| 11 | |||
| 12 | <!-- A clear and concise description of what the bug is. --> | ||
| 13 | |||
| 14 | **System Information** | ||
| 15 | - Keyboard: | ||
| 16 | - Revision (if applicable): | ||
| 17 | - Operating System: | ||
| 18 | - avr-gcc version: | ||
| 19 | <!-- Run `avr-gcc --version` to find out --> | ||
| 20 | - arm gcc version: | ||
| 21 | <!-- Run `arm-none-eabi-gcc --version` to find out --> | ||
| 22 | - QMK Firmware version: | ||
| 23 | <!-- You can run `git describe --abbrev=0 --tags` to find this out --> | ||
| 24 | - Any keyboard related software installed? | ||
| 25 | - [ ] Auto Hot Key | ||
| 26 | - [ ] Karabiner | ||
| 27 | - [ ] Other | ||
| 28 | |||
| 29 | **Additional context** | ||
| 30 | |||
| 31 | <!-- 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..c9198adff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md | |||
| @@ -0,0 +1,19 @@ | |||
| 1 | --- | ||
| 2 | name: Feature request | ||
| 3 | about: Suggest a new feature or changes to existing features | ||
| 4 | --- | ||
| 5 | <!--- Provide a general summary of the changes you want in the Title above --> | ||
| 6 | |||
| 7 | <!-- This template is entirely option and can be removed, but is here to help both you and us. --> | ||
| 8 | <!-- 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. --> | ||
| 9 | |||
| 10 | ## Feature Request Type | ||
| 11 | |||
| 12 | - [ ] Core Functionality | ||
| 13 | - [ ] Add-on hardware support (e.g. audio, RGB, OLED screen, etc.) | ||
| 14 | - [ ] Alteration (enhancement/optimization) of existing Feature(s) | ||
| 15 | - [ ] New behavior | ||
| 16 | |||
| 17 | ## Description | ||
| 18 | |||
| 19 | <!-- 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. --> | ||
diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md new file mode 100644 index 000000000..5f3e986cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issues.md | |||
| @@ -0,0 +1,9 @@ | |||
| 1 | --- | ||
| 2 | name: Other issues | ||
| 3 | about: Anything else that doesn't fall into the above categories. | ||
| 4 | --- | ||
| 5 | <!--- Provide a general summary of the changes you want in the Title above --> | ||
| 6 | |||
| 7 | <!-- 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. --> | ||
| 8 | |||
| 9 | <!-- 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. --> | ||
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..05223aa4f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md | |||
| @@ -0,0 +1,32 @@ | |||
| 1 | <!--- Provide a general summary of your changes in the Title above --> | ||
| 2 | |||
| 3 | <!--- This template is entirely option and can be removed, but is here to help both you and us. --> | ||
| 4 | <!--- 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. --> | ||
| 5 | |||
| 6 | ## Description | ||
| 7 | <!--- Describe your changes in detail --> | ||
| 8 | |||
| 9 | ## Types of changes | ||
| 10 | <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| 11 | - [ ] Core | ||
| 12 | - [ ] Bugfix | ||
| 13 | - [ ] New Feature | ||
| 14 | - [ ] Enhancement/Optimization | ||
| 15 | - [ ] Keyboard (addition or update) | ||
| 16 | - [ ] Keymap/Layout/Userspace (addition or update) | ||
| 17 | - [ ] Documentation | ||
| 18 | |||
| 19 | |||
| 20 | ## Issues Fixed or Closed by this PR | ||
| 21 | |||
| 22 | * | ||
| 23 | |||
| 24 | ## Checklist: | ||
| 25 | <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
| 26 | <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
| 27 | - [ ] My code follows the code style of this project. | ||
| 28 | - [ ] My change requires a change to the documentation. | ||
| 29 | - [ ] I have updated the documentation accordingly. | ||
| 30 | - [ ] I have read the **CONTRIBUTING** document. (https://docs.qmk.fm/#/contributing) | ||
| 31 | - [ ] I have added tests to cover my changes. | ||
| 32 | - [ ] I have tested the changes and verified that they work and don't break anything (as well as I can manage). | ||
diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 6338d6912..b209c5e0b 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md | |||
| @@ -88,6 +88,7 @@ | |||
| 88 | 88 | ||
| 89 | * Other Topics | 89 | * Other Topics |
| 90 | * [Using Eclipse with QMK](eclipse.md) | 90 | * [Using Eclipse with QMK](eclipse.md) |
| 91 | * [Support](support.md) | ||
| 91 | 92 | ||
| 92 | * QMK Internals (In Progress) | 93 | * QMK Internals (In Progress) |
| 93 | * [Defines](internals_defines.md) | 94 | * [Defines](internals_defines.md) |
diff --git a/docs/_summary.md b/docs/_summary.md index 6338d6912..b209c5e0b 100644 --- a/docs/_summary.md +++ b/docs/_summary.md | |||
| @@ -88,6 +88,7 @@ | |||
| 88 | 88 | ||
| 89 | * Other Topics | 89 | * Other Topics |
| 90 | * [Using Eclipse with QMK](eclipse.md) | 90 | * [Using Eclipse with QMK](eclipse.md) |
| 91 | * [Support](support.md) | ||
| 91 | 92 | ||
| 92 | * QMK Internals (In Progress) | 93 | * QMK Internals (In Progress) |
| 93 | * [Defines](internals_defines.md) | 94 | * [Defines](internals_defines.md) |
diff --git a/docs/support.md b/docs/support.md new file mode 100644 index 000000000..5c275b07e --- /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/new)! | ||
| 22 | |||
| 23 | ## What if I found a bug? | ||
| 24 | |||
| 25 | 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. | ||
| 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 [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. | ||
| 42 | |||
| 43 | If you have any questions about this, open an issue or head to [Discord](https://discord.gg/Uq7gcHh). | ||
