From 8f26da39d51bfccef70fc10c2a1571a362c4d72a Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 12:21:51 -0800 Subject: [PATCH 1/7] Add support document --- docs/SUPPORT.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/SUPPORT.md diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md new file mode 100644 index 000000000000..28894c2c3158 --- /dev/null +++ b/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). From 444553541647fbdc36c1e00a7362e1ad7d4353ca Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 12:50:47 -0800 Subject: [PATCH 2/7] Add Bug Report --- .github/ISSUE_TEMPLATE/bug_report.md | 27 +++++++++++++++++++++++++++ {docs => .github}/SUPPORT.md | 0 2 files changed, 27 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md rename {docs => .github}/SUPPORT.md (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000000..ed5d56ce32b8 --- /dev/null +++ b/.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. diff --git a/docs/SUPPORT.md b/.github/SUPPORT.md similarity index 100% rename from docs/SUPPORT.md rename to .github/SUPPORT.md From 2302e593eea3a275d007b105b65ebe7b5f9cc55b Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 13:55:27 -0800 Subject: [PATCH 3/7] Add GitHub Pull Request Template --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..36410da266fe --- /dev/null +++ b/.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. From 54b240108a314ac09da43c84bf5e49f17b32c8fd Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 13:56:14 -0800 Subject: [PATCH 4/7] Feature request issue template --- .github/ISSUE_TEMPLATE/feature_request.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000000..2d5c6cf857d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,10 @@ +--- +name: Feature request +about: Suggest a new feature or changes to existing features + +--- + +- [ ] Core Functionality +- [ ] Add on hardware support +- [ ] Alteration to existing Feature +- [ ] From f363ef6d479da4b1f39591c47c778cabb6b0e73c Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:04:34 -0800 Subject: [PATCH 5/7] Touch up feature request template --- .github/ISSUE_TEMPLATE/feature_request.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2d5c6cf857d1..ac924b3ac7f8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,7 +4,12 @@ about: Suggest a new feature or changes to existing features --- +## Feature Request Type + - [ ] Core Functionality -- [ ] Add on hardware support -- [ ] Alteration to existing Feature -- [ ] +- [ ] 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. From d2bda1c3d3957dea97110ee4280334c110703d1c Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:08:16 -0800 Subject: [PATCH 6/7] Add 'other issues' template --- .github/ISSUE_TEMPLATE/other_issues.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/other_issues.md diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md new file mode 100644 index 000000000000..a1302cb381dc --- /dev/null +++ b/.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, then please open a bug report, if applicable. From 48130f0703e857e7d3a4e0fc12fb579acc54736d Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:33:34 -0800 Subject: [PATCH 7/7] move support doc --- .github/ISSUE_TEMPLATE/other_issues.md | 2 +- .github/SUPPORT.md => docs/support.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename .github/SUPPORT.md => docs/support.md (100%) diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md index a1302cb381dc..53481f9ab89a 100644 --- a/.github/ISSUE_TEMPLATE/other_issues.md +++ b/.github/ISSUE_TEMPLATE/other_issues.md @@ -4,4 +4,4 @@ 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, then please open a bug report, if applicable. +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/SUPPORT.md b/docs/support.md similarity index 100% rename from .github/SUPPORT.md rename to docs/support.md