]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - .github/PULL_REQUEST_TEMPLATE.md
Clarify LAYOUT vs LAYOUT_all
[qmk_firmware.git] / .github / PULL_REQUEST_TEMPLATE.md
index 36410da266fe5e4eb80b573f176259201e691d50..05223aa4f6b3044ab58f166265ffee8440a792d1 100644 (file)
@@ -1,22 +1,32 @@
-## Code Change Type
+<!--- 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
-- [ ] 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:
+<!--- 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).