From 1cfba49f262c3c275ce579cd529a619531487de5 Mon Sep 17 00:00:00 2001 From: raman325 <7243222+raman325@users.noreply.github.com> Date: Fri, 27 Mar 2026 20:49:33 -0400 Subject: [PATCH 1/5] Update bug report template with debug logs and diagnostics guidance Add inline instructions and wiki links for enabling debug logging and downloading device diagnostics. Add a new device diagnostics field with JSON rendering. Co-Authored-By: Claude Opus 4.6 Entire-Checkpoint: 950bde68c150 --- .github/ISSUE_TEMPLATE/bug_report.yml | 34 +++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c09b93fd..31dea7dd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,6 +8,10 @@ body: attributes: value: | Thanks for taking the time to fill out this bug report! + + For guidance on gathering the information below, see the + [Troubleshooting](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting) + wiki page. - type: textarea id: what-happened attributes: @@ -58,16 +62,36 @@ body: - type: markdown attributes: value: | - ## Additional details + ## Diagnostics & Logs + + Debug logs and device diagnostics are the two most important pieces of + information for diagnosing issues. See the + [Troubleshooting](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting) + wiki for detailed instructions on gathering both. - type: textarea id: logs attributes: - label: Relevant log output + label: Debug logs description: > - Please set the log level for the integration to debug, reproduce the issue, - and copy and paste any relevant log output. This will be automatically - formatted into code, so no need for backticks. + Enable debug logging by adding + `custom_components.lock_code_manager: debug` under `logger > logs` in + your `configuration.yaml`, restart, reproduce the issue, then paste the + relevant log lines here. See the + [Debug Logs](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Debug-Logs) + wiki page for detailed instructions. This field is automatically + formatted as code. render: shell + - type: textarea + id: diagnostics + attributes: + label: Device diagnostics + description: > + Download diagnostics for your lock device from + Settings → Devices & Services → [your lock integration] → [lock device] + → ⋮ → Download diagnostics. Paste the JSON here or attach the file. See the + [Device Diagnostics](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Device-Diagnostics) + wiki page for detailed instructions. + render: json - type: textarea id: screenshots attributes: From 863f41223cee83a651f064f4e53aa2eae1b347db Mon Sep 17 00:00:00 2001 From: raman325 <7243222+raman325@users.noreply.github.com> Date: Fri, 27 Mar 2026 20:50:46 -0400 Subject: [PATCH 2/5] Use file upload field for device diagnostics Switch from textarea with JSON rendering to native upload element so users can drag-and-drop the diagnostics JSON file directly. Co-Authored-By: Claude Opus 4.6 Entire-Checkpoint: 211ccbb52823 --- .github/ISSUE_TEMPLATE/bug_report.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 31dea7dd..31966655 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -81,17 +81,16 @@ body: wiki page for detailed instructions. This field is automatically formatted as code. render: shell - - type: textarea + - type: upload id: diagnostics attributes: label: Device diagnostics description: > Download diagnostics for your lock device from Settings → Devices & Services → [your lock integration] → [lock device] - → ⋮ → Download diagnostics. Paste the JSON here or attach the file. See the + → ⋮ → Download diagnostics, then upload the JSON file here. See the [Device Diagnostics](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Device-Diagnostics) wiki page for detailed instructions. - render: json - type: textarea id: screenshots attributes: From 4086c97c82ed697724c17c8fc6dd8fa1baa3f05f Mon Sep 17 00:00:00 2001 From: raman325 <7243222+raman325@users.noreply.github.com> Date: Fri, 27 Mar 2026 20:54:18 -0400 Subject: [PATCH 3/5] Add both paste and upload options; include lock integration logger - Add upload alternative for debug logs - Add paste alternative for device diagnostics - Include homeassistant.components.zwave_js in debug logging instructions Co-Authored-By: Claude Opus 4.6 Entire-Checkpoint: e5163891a24a --- .github/ISSUE_TEMPLATE/bug_report.yml | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 31966655..0a278094 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -71,26 +71,43 @@ body: - type: textarea id: logs attributes: - label: Debug logs + label: Debug logs (paste) description: > Enable debug logging by adding - `custom_components.lock_code_manager: debug` under `logger > logs` in - your `configuration.yaml`, restart, reproduce the issue, then paste the + `custom_components.lock_code_manager: debug` and + `homeassistant.components.zwave_js: debug` (replace with your lock's + integration if not Z-Wave) under `logger > logs` in your + `configuration.yaml`, restart, reproduce the issue, then paste the relevant log lines here. See the [Debug Logs](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Debug-Logs) wiki page for detailed instructions. This field is automatically formatted as code. render: shell + - type: upload + id: logs-upload + attributes: + label: Debug logs (upload) + description: > + Alternatively, upload a log file here. You can download the full log + from Settings → System → Logs → Download full log. - type: upload id: diagnostics attributes: - label: Device diagnostics + label: Device diagnostics (upload) description: > Download diagnostics for your lock device from Settings → Devices & Services → [your lock integration] → [lock device] → ⋮ → Download diagnostics, then upload the JSON file here. See the [Device Diagnostics](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Device-Diagnostics) wiki page for detailed instructions. + - type: textarea + id: diagnostics-paste + attributes: + label: Device diagnostics (paste) + description: > + Alternatively, paste the diagnostics JSON here. This field is + automatically formatted as JSON. + render: json - type: textarea id: screenshots attributes: From 939e3be1a3a483a31e741f80a04a3f96197b1f94 Mon Sep 17 00:00:00 2001 From: raman325 <7243222+raman325@users.noreply.github.com> Date: Fri, 27 Mar 2026 20:55:39 -0400 Subject: [PATCH 4/5] Clarify that only the domain name needs replacing in logger config Co-Authored-By: Claude Opus 4.6 Entire-Checkpoint: 961fd2bc080b --- .github/ISSUE_TEMPLATE/bug_report.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 0a278094..8e4c1d6c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -75,8 +75,9 @@ body: description: > Enable debug logging by adding `custom_components.lock_code_manager: debug` and - `homeassistant.components.zwave_js: debug` (replace with your lock's - integration if not Z-Wave) under `logger > logs` in your + `homeassistant.components.zwave_js: debug` (replace `zwave_js` with + your lock integration's domain if not Z-Wave) under `logger > logs` in + your `configuration.yaml`, restart, reproduce the issue, then paste the relevant log lines here. See the [Debug Logs](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Debug-Logs) From 0e8759644947423ad95f936c93b6b8f3a65c3ed0 Mon Sep 17 00:00:00 2001 From: raman325 <7243222+raman325@users.noreply.github.com> Date: Fri, 27 Mar 2026 21:13:01 -0400 Subject: [PATCH 5/5] Add browser console logs section for frontend issues Add paste and upload fields for browser console output, with a Frontend Issues header linking to the wiki for instructions. Co-Authored-By: Claude Opus 4.6 Entire-Checkpoint: dbc97195020a --- .github/ISSUE_TEMPLATE/bug_report.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8e4c1d6c..925d3e7a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -109,6 +109,31 @@ body: Alternatively, paste the diagnostics JSON here. This field is automatically formatted as JSON. render: json + - type: markdown + attributes: + value: | + ## Frontend Issues + + If your issue involves the dashboard, cards, or UI, include browser + console logs. See the + [Browser Console Logs](https://github.com/raman325/lock_code_manager/wiki/Troubleshooting-Browser-Console-Logs) + wiki page for instructions on opening the console in your browser. + - type: textarea + id: console-logs + attributes: + label: Browser console logs (paste) + description: > + Open the browser console (F12 → Console tab) before reproducing the + issue, then paste the output here. This field is automatically formatted + as code. + render: shell + - type: upload + id: console-logs-upload + attributes: + label: Browser console logs (upload) + description: > + Alternatively, right-click in the console and select "Save as..." to + download the log, then upload it here. - type: textarea id: screenshots attributes: