Formatting and additional changes

qmk · Dec 6, 2018 · fafca48 · fafca48
1 parent ab6674d
commit fafca48
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,26 +2,30 @@
 name: Bug report
 about: Create a report to help us improve the QMK Firmware
 ---
+<!-- Provide a general summary of the bug 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. -->
 
 **Describe the bug**
 
-A clear and concise description of what the bug is.
+<!-- 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)
+<!-- Run `avr-gcc --version` to find out -->
  - arm gcc version: 
-   (Run `arm-none-eabi-gcc --version` to find out)
+<!-- Run `arm-none-eabi-gcc --version` to find out -->
  - QMK Firmware version:
-   (you can run `git describe --abbrev=0 --tags` to find this out)
+<!-- 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.
+<!-- Add any other context about the problem here. --> 
diff --git 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 
-
 ---
+<!--- Provide a general summary of the changes you want 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. -->
 
 ## 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. 
+
+<!-- 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
@@ -1,7 +1,9 @@
 ---
 name: Other issues
 about: Anything else that doesn't fall into the above categories. 
-
 ---
+<!--- Provide a general summary of the changes you want in the Title above -->
+
+<!-- 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. -->
 
-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. 
+<!-- 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
@@ -1,6 +1,7 @@
 <!--- Provide a general summary of your changes in the Title above -->
 
-<!--- This template is entirely option and can be reomved, but is here to help both you and us. -->
+<!--- 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 -->