Update bug issue template

node-alarm-dot-com · Jul 15, 2020 · 5d0258a · 5d0258a
1 parent 301799b
commit 5d0258a
Showing 1 changed file with 16 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,29 +7,36 @@ assignees: ''
 
 ---
 
+<!-- You must use the issue template below when submitting a bug -->
+
 **Describe the bug**
-A clear and concise description of what the bug is.
+<!-- A clear and concise description of what the bug is. -->
 
 **To Reproduce**
-Steps to reproduce the behavior:
+<!-- Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
+-->
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
+<!-- If applicable, add screenshots to help explain your problem. -->
 
 **ADC-SystemStates.json**
-Attach the `ADC-SystemStates.json` troubleshooting file. To create this file, set your Log Level to 4. The file can be found in the same folder as your Homebridge config.json file. The file path is also printed out in the logs every Device Poll Interval (default: 60 seconds).
+<!-- Attach the `ADC-SystemStates.json` troubleshooting file. To create this file, set your Log Level to 4. The file can be found in the same folder as your Homebridge config.json file. The file path is also printed out in the logs every Device Poll Interval (default: 60 seconds). Make sure to comment out any existing sensitive information. -->
 
 **Homebridge System (please complete the following information):**
- - Hardware: [e.g. Pi3, MacMini, etc.]
- - OS: [e.g. Ubuntu]
- - Node Type/Version: [node10, PM2]
+* **Node.js Version**: <!-- node -v -->
+* **NPM Version**: <!-- npm -v -->
+* **Homebridge Version**: <!-- homebridge -V -->
+* **Operating System**: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
+* **Process Supervisor**: Docker / Systemd / init.d / pm2 / launchctl / hb-service / other / none
 
 **Additional context**
-Add any other context about the problem here.
+<!-- Add any other context about the problem here.
+
+<!-- Click the "Preview" tab before you submit to ensure the formatting is correct. -->