From f4dbde51bd238a681cc0b9e37cb42c2108a70bf5 Mon Sep 17 00:00:00 2001
From: Chuck <chuck@example.com>
Date: Tue, 7 Apr 2026 13:22:41 -0400
Subject: [PATCH] Customize bug report template for LEDMatrix hardware
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The bug_report.md template was the GitHub default and asked
"Desktop (OS/Browser/Version)" and "Smartphone (Device/OS)" — neither
of which is relevant for a project that runs on a Raspberry Pi with
hardware LED panels. A user filing a bug under the old template was
giving us none of the information we'd actually need to triage it.

Replaced with a LEDMatrix-aware template that prompts for:
- Pi model, OS/kernel, panel type, HAT/Bonnet, PWM jumper status,
  display chain dimensions
- LEDMatrix git commit / release tag
- Plugin id and version (if the bug is plugin-related)
- Relevant config snippet (with redaction reminder for API keys)
- journalctl log excerpt with the exact command to capture it
- Optional photo of the actual display for visual issues

Kept feature_request.md as-is — generic content there is fine.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---
 .github/ISSUE_TEMPLATE/bug_report.md | 96 ++++++++++++++++++++--------
 1 file changed, 71 insertions(+), 25 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd84ea78..20e9940d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,38 +1,84 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Report a problem with LEDMatrix
 title: ''
-labels: ''
+labels: bug
 assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+<!--
+Before filing: please check existing issues to see if this is already
+reported. For security issues, see SECURITY.md and report privately.
+-->
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+## Describe the bug
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what the bug is. -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+## Steps to reproduce
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+1.
+2.
+3.
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+## Expected behavior
 
-**Additional context**
-Add any other context about the problem here.
+<!-- What you expected to happen. -->
+
+## Actual behavior
+
+<!-- What actually happened. Include any error messages. -->
+
+## Hardware
+
+- **Raspberry Pi model**: <!-- e.g. Pi 3B+, Pi 4 8GB, Pi Zero 2W -->
+- **OS / kernel**: <!-- output of `cat /etc/os-release` and `uname -a` -->
+- **LED matrix panels**: <!-- e.g. 2x Adafruit 64x32, 1x Waveshare 96x48 -->
+- **HAT / Bonnet**: <!-- e.g. Adafruit RGB Matrix Bonnet, Electrodragon HAT -->
+- **PWM jumper mod soldered?**: <!-- yes / no -->
+- **Display chain**: <!-- chain_length × parallel, e.g. "2x1" -->
+
+## LEDMatrix version
+
+<!-- Run `git rev-parse HEAD` in the LEDMatrix directory, or paste the
+release tag if you installed from a release. -->
+
+```
+git commit:
+```
+
+## Plugin involved (if any)
+
+- **Plugin id**:
+- **Plugin version** (from `manifest.json`):
+
+## Configuration
+
+<!-- Paste the relevant section from config/config.json. Redact any
+API keys before pasting. For display issues, the `display.hardware`
+block is most relevant. For plugin issues, paste that plugin's section. -->
+
+```json
+```
+
+## Logs
+
+<!-- The first 50 lines of the relevant log are usually enough. Run:
+  sudo journalctl -u ledmatrix -n 100 --no-pager
+or for the web service:
+  sudo journalctl -u ledmatrix-web -n 100 --no-pager
+-->
+
+```
+```
+
+## Screenshots / video (optional)
+
+<!-- A photo of the actual display, or a screenshot of the web UI,
+helps a lot for visual issues. -->
+
+## Additional context
+
+<!-- Anything else that might be relevant: when did this start happening,
+what's different about your setup, what have you already tried, etc. -->