From 73b549c33e1ba102f5fd92a32f4bc6127d7c2cb5 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 12:21:51 -0800 Subject: [PATCH 01/16] 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 23205264961bea73a653cebfa7fccc6028ffbfda Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 12:50:47 -0800 Subject: [PATCH 02/16] 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 6c83869b9173d72fb688cd0651a4dd423a1314dd Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 13:55:27 -0800 Subject: [PATCH 03/16] 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 ae82c30a663161d88b8c7e393cf3398b5ae0f97a Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 13:56:14 -0800 Subject: [PATCH 04/16] 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 c4dd9eb5b864e81e526a590fd95bbb4dda89cccf Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:04:34 -0800 Subject: [PATCH 05/16] 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 7e905041164eea3b05c5d65caa076031b5d03621 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:08:16 -0800 Subject: [PATCH 06/16] 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 1b1816ccf5388eae0e7c08f191d7f78a8d7959a8 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:33:34 -0800 Subject: [PATCH 07/16] 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 From dba9be4eb103be515e21d04622098cba17c2576d Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:45:07 -0800 Subject: [PATCH 08/16] Minor tweaks --- .github/ISSUE_TEMPLATE/other_issues.md | 2 +- docs/_sidebar.md | 1 + docs/_summary.md | 1 + docs/support.md | 2 +- 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md index 53481f9ab89a..c2896b6bdaf1 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, check the bug report option, as that may be more appropriate. +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/docs/_sidebar.md b/docs/_sidebar.md index 6338d69121a7..b209c5e0b872 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -88,6 +88,7 @@ * Other Topics * [Using Eclipse with QMK](eclipse.md) + * [Support](support.md) * QMK Internals (In Progress) * [Defines](internals_defines.md) diff --git a/docs/_summary.md b/docs/_summary.md index 6338d69121a7..b209c5e0b872 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -88,6 +88,7 @@ * Other Topics * [Using Eclipse with QMK](eclipse.md) + * [Support](support.md) * QMK Internals (In Progress) * [Defines](internals_defines.md) diff --git a/docs/support.md b/docs/support.md index 28894c2c3158..410b5a91cebf 100644 --- a/docs/support.md +++ b/docs/support.md @@ -38,6 +38,6 @@ Awesome! Open up a Pull Request for it. We'll review the code, and merge it! 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. +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). From 5a7bb67b02608c58cae7c4ca8dd1abbd47aabbb9 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 14:46:54 -0800 Subject: [PATCH 09/16] More minor tweaks --- .github/ISSUE_TEMPLATE/other_issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md index c2896b6bdaf1..54ddd52ab10b 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, check the bug report option, as that may be more appropriate. +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. From a070cfc2065f0849b21c63bff2e254ff20b83a4b Mon Sep 17 00:00:00 2001 From: MechMerlin <30334081+mechmerlin@users.noreply.github.com> Date: Mon, 26 Nov 2018 15:21:04 -0800 Subject: [PATCH 10/16] Spleeling fix Co-Authored-By: drashna --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ac924b3ac7f8..ed95db2a40d7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -12,4 +12,4 @@ about: Suggest a new feature or changes to existing features - [ ] 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. +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. From 985203e68bb0b9d802eff16345c21db251e4dc02 Mon Sep 17 00:00:00 2001 From: noroadsleft <18669334+noroadsleft@users.noreply.github.com> Date: Mon, 26 Nov 2018 15:26:02 -0800 Subject: [PATCH 11/16] CapiTALization fIXes Co-Authored-By: drashna --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index ed95db2a40d7..553510986051 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,7 +7,7 @@ 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) +- [ ] Add-on hardware support (e.g. audio, RGB, OLED screen, etc.) - [ ] Alteration (enhancement/optimization) of existing Feature(s) - [ ] New behavior From d1c35e235668974d40e5595fd48678b049792011 Mon Sep 17 00:00:00 2001 From: noroadsleft <18669334+noroadsleft@users.noreply.github.com> Date: Mon, 26 Nov 2018 15:26:50 -0800 Subject: [PATCH 12/16] Use new issue URL Co-Authored-By: drashna --- docs/support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/support.md b/docs/support.md index 410b5a91cebf..7c9d9064640d 100644 --- a/docs/support.md +++ b/docs/support.md @@ -18,7 +18,7 @@ First, head to the [Compiling/Flashing FAQ Page](https://docs.qmk.fm/#/faq_build 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)! +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? From 759213719d6b3d44e54edcc2f7316a98216d7062 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Mon, 26 Nov 2018 15:28:26 -0800 Subject: [PATCH 13/16] Add blanck issue template --- .github/ISSUE_TEMPLATE/blank.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/blank.md diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md new file mode 100644 index 000000000000..50a32034d6e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank.md @@ -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. + +--- From ab6674d8674dfea4742322a4eeed89e259ef6d05 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Tue, 27 Nov 2018 09:31:20 -0800 Subject: [PATCH 14/16] Update the PR template --- .github/PULL_REQUEST_TEMPLATE.md | 33 ++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 36410da266fe..cecb15976dc0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,31 @@ -## Code Change Type + + + + +## Description + + +## Types of changes + - [ ] Core -- [ ] Feature - [ ] Bugfix -- [ ] Keyboard -- [ ] Keymap/Layout/Userspace +- [ ] New Feature - [ ] Enhancement/Optimization +- [ ] Keyboard (addition or update) +- [ ] Keymap/Layout/Userspace (addition or update) - [ ] 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. +## Checklist: + + +- [ ] 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). From fafca48558d047004b2e3523f1bc9d8f2fb90c86 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Wed, 5 Dec 2018 10:15:10 -0800 Subject: [PATCH 15/16] Formatting and additional changes --- .github/ISSUE_TEMPLATE/bug_report.md | 14 +++++++++----- .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++++-- .github/ISSUE_TEMPLATE/other_issues.md | 6 ++++-- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 4 files changed, 21 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ed5d56ce32b8..a4f90389b0f0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,21 +2,25 @@ 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 @@ -24,4 +28,4 @@ A clear and concise description of what the bug is. **Additional context** -Add any other context about the problem here. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 553510986051..c9198adff2fc 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,8 +1,11 @@ --- name: Feature request about: Suggest a new feature or changes to existing features - --- + + + + ## Feature Request Type @@ -12,4 +15,5 @@ about: Suggest a new feature or changes to existing features - [ ] 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. + + diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md index 54ddd52ab10b..5f3e986cc413 100644 --- a/.github/ISSUE_TEMPLATE/other_issues.md +++ b/.github/ISSUE_TEMPLATE/other_issues.md @@ -1,7 +1,9 @@ --- name: Other issues about: Anything else that doesn't fall into the above categories. - --- + + + -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 index cecb15976dc0..05223aa4f6b3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,7 @@ - + + ## Description From 842d1a7d56be40e87e114cbe98d2e6c02fa31b41 Mon Sep 17 00:00:00 2001 From: MechMerlin <30334081+mechmerlin@users.noreply.github.com> Date: Fri, 7 Dec 2018 13:46:49 -0800 Subject: [PATCH 16/16] Update docs/support.md Co-Authored-By: drashna --- docs/support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/support.md b/docs/support.md index 7c9d9064640d..5c275b07e4ba 100644 --- a/docs/support.md +++ b/docs/support.md @@ -22,7 +22,7 @@ If you can't find anything, then please open a [new issue](https://github.com/qm ## 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. +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!