docs: Streamline bug-report template

OpenShock · Oct 18, 2023 · 7e183b0 · 7e183b0
1 parent 943c215
commit 7e183b0
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 13 deletions.
diff --git a/.github/ISSUE_TEMPLATE/10-bug-report.yml b/.github/ISSUE_TEMPLATE/10-bug-report.yml
@@ -51,7 +51,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        # What did you expect to happen instead?
+        # What did you expect to happen?
 
   - type: textarea
     id: what-did-you-expect
@@ -63,21 +63,40 @@ body:
   - type: markdown
     attributes:
       value: |
-        # How to reproduce the problem?
-    validations:
-      required: true
+        # Steps to reproduce
 
   - type: textarea
     id: how-to-reproduce
     attributes:
       label: 'In as much detail as possible, describe the exact steps you took to make the problem appear.'
       description: |
-        If we can't reproduce the problem, we have no way of figuring out what's going on behind the scenes.
-        Make sure to be as precise as you can!
+        If we can't reproduce the problem, we won't be able to figure out how to fix it either!
+        Make sure to be as precise as you can.
       placeholder: |
         1. Turn on the board
         2. Go to captive portal
         3. Click a WiFi network
         4. The world catches fire!
     validations:
       required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        # Anything else?
+
+  - type: textarea
+    id: anything-else
+    attributes:
+      label: 'Feel free to share.'
+      description: |
+        If we can't reproduce the problem, we have no way of figuring out what's going on behind the scenes.
+        Make sure to be as precise as you can!
+      placeholder: |
+        For example:
+        1. Connect to the boards' wifi network
+        2. Visit `http://10.10.10.10/`
+        3. Click a WiFi network
+        4. Nothing happens!
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,8 @@
 blank_issues_enabled: true
-contact_links:
-  - name: GitHub Community Support
-    url: https://github.com/orgs/community/discussions
-    about: Please ask and answer questions here.
-  - name: GitHub Security Bug Bounty
-    url: https://bounty.github.com/
-    about: Please report security vulnerabilities here.
+# contact_links:
+#   - name: GitHub Community Support
+#     url: https://github.com/orgs/community/discussions
+#     about: Please ask and answer questions here.
+#   - name: GitHub Security Bug Bounty
+#     url: https://bounty.github.com/
+#     about: Please report security vulnerabilities here.