Add effect range to rgblight.c (#5856)

[qmk_firmware.git] / .github / ISSUE_TEMPLATE / bug_report.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index ed5d56ce32b85dc0d1f8151aa979b32161359cb5..3c35416e043fa54444ffdfb613c689f565a0d79f 100644 (file)
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,26 +2,31 @@
 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. -->
 
-**Describe the bug**
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
 
-A clear and concise description of what the bug is.
+## Describe the Bug
+
+<!-- A clear and concise description of what the bug is. -->
+
+## System Information
 
-**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)
+ - Operating system:
+ - AVR GCC version: 
+<!-- Run `avr-gcc --version` to find this out. -->
+ - ARM GCC version: 
+<!-- Run `arm-none-eabi-gcc --version` to find this out. -->
  - QMK Firmware version:
-   (you can run `git describe --abbrev=0 --tags` to find this out)
+<!-- Run `git describe --abbrev=0 --tags` to find this out. -->
  - Any keyboard related software installed? 
-   - [ ] Auto Hot Key
+   - [ ] AutoHotKey
    - [ ] Karabiner
-   - [ ] Other
+   - [ ] Other:
 
-**Additional context**
+## Additional Context
 
-Add any other context about the problem here.
+<!-- Add any other relevant information about the problem here. -->