summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/bug_report.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE/bug_report.md')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md31
1 files changed, 16 insertions, 15 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index a4f90389b..3c35416e0 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,30 +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 -->
+<!-- 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. -->
+<!--- 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. -->
-**Describe the bug**
+## 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. -->