Browse Source

Tweak issue templates (capitalisation mostly) (#5133)

* Tweak issue templates (capitalisation mostly)

* Consistent headings
pjones-keymap
fauxpark 4 months ago
parent
commit
3a3de84e40

+ 16
- 15
.github/ISSUE_TEMPLATE/bug_report.md View File

@@ -2,30 +2,31 @@
2 2
 name: Bug report
3 3
 about: Create a report to help us improve the QMK Firmware
4 4
 ---
5
-<!-- Provide a general summary of the bug in the Title above -->
5
+<!-- Provide a general summary of the bug in the title above. -->
6 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. -->
7
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
8
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
9 9
 
10
-**Describe the bug**
10
+## Describe the Bug
11 11
 
12 12
 <!-- A clear and concise description of what the bug is. -->
13 13
 
14
-**System Information**
14
+## System Information
15
+
15 16
  - Keyboard:  
16 17
    - 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 -->
18
+ - Operating system:
19
+ - AVR GCC version: 
20
+<!-- Run `avr-gcc --version` to find this out. -->
21
+ - ARM GCC version: 
22
+<!-- Run `arm-none-eabi-gcc --version` to find this out. -->
22 23
  - QMK Firmware version:
23
-<!-- You can run `git describe --abbrev=0 --tags` to find this out -->
24
+<!-- Run `git describe --abbrev=0 --tags` to find this out. -->
24 25
  - Any keyboard related software installed? 
25
-   - [ ] Auto Hot Key
26
+   - [ ] AutoHotKey
26 27
    - [ ] Karabiner
27
-   - [ ] Other
28
+   - [ ] Other:
28 29
 
29
-**Additional context**
30
+## Additional Context
30 31
 
31
-<!-- Add any other context about the problem here. --> 
32
+<!-- Add any other relevant information about the problem here. -->

+ 8
- 8
.github/ISSUE_TEMPLATE/feature_request.md View File

@@ -2,18 +2,18 @@
2 2
 name: Feature request
3 3
 about: Suggest a new feature or changes to existing features 
4 4
 ---
5
-<!--- Provide a general summary of the changes you want in the Title above -->
5
+<!--- Provide a general summary of the changes you want in the title above. -->
6 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. -->
7
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
8
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
9 9
 
10 10
 ## Feature Request Type
11 11
 
12
-- [ ] Core Functionality
13
-- [ ] Add-on hardware support (e.g. audio, RGB, OLED screen, etc.)
14
-- [ ] Alteration (enhancement/optimization) of existing Feature(s)
12
+- [ ] Core functionality
13
+- [ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
14
+- [ ] Alteration (enhancement/optimization) of existing feature(s)
15 15
 - [ ] New behavior
16 16
 
17
-## Description 
17
+## Description
18 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. -->
19
+<!-- A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful. -->

+ 3
- 3
.github/ISSUE_TEMPLATE/other_issues.md View File

@@ -2,8 +2,8 @@
2 2
 name: Other issues
3 3
 about: Anything else that doesn't fall into the above categories. 
4 4
 ---
5
-<!--- Provide a general summary of the changes you want in the Title above -->
5
+<!--- Provide a general summary of the changes you want in the title above. -->
6 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. -->
7
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
8 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. -->
9
+<!-- Please check https://docs.qmk.fm/#/support for additional resources first. If that doesn't answer your question, choose the bug report template instead, as that may be more appropriate. -->

+ 15
- 13
.github/PULL_REQUEST_TEMPLATE.md View File

@@ -1,32 +1,34 @@
1
-<!--- Provide a general summary of your changes in the Title above -->
1
+<!--- Provide a general summary of your changes in the title above. -->
2 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. -->
3
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
4
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
5 5
 
6 6
 ## Description
7
-<!--- Describe your changes in detail -->
8 7
 
9
-## Types of changes
10
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
8
+<!--- Describe your changes in detail here. -->
9
+
10
+## Types of Changes
11
+
12
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
11 13
 - [ ] Core
12 14
 - [ ] Bugfix
13
-- [ ] New Feature
14
-- [ ] Enhancement/Optimization
15
+- [ ] New feature
16
+- [ ] Enhancement/optimization
15 17
 - [ ] Keyboard (addition or update)
16
-- [ ] Keymap/Layout/Userspace (addition or update)
18
+- [ ] Keymap/layout/userspace (addition or update)
17 19
 - [ ] Documentation
18 20
 
19
-
20
-## Issues Fixed or Closed by this PR
21
+## Issues Fixed or Closed by This PR
21 22
 
22 23
 * 
23 24
 
24
-## Checklist:
25
+## Checklist
26
+
25 27
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
26 28
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
27 29
 - [ ] My code follows the code style of this project.
28 30
 - [ ] My change requires a change to the documentation.
29 31
 - [ ] I have updated the documentation accordingly.
30
-- [ ] I have read the **CONTRIBUTING** document. (https://docs.qmk.fm/#/contributing)
32
+- [ ] I have read the [**CONTRIBUTING** document](https://docs.qmk.fm/#/contributing).
31 33
 - [ ] I have added tests to cover my changes.
32 34
 - [ ] I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Loading…
Cancel
Save