From ed89d1da74fcb65b8b023b45bd581d84e1e13f48 Mon Sep 17 00:00:00 2001 From: Philip Abbey Date: Sun, 12 Apr 2026 12:56:52 +0100 Subject: [PATCH] Revise bug report template for clarity Updated bug report template to clarify issue attribution and wording. Signed-off-by: Philip Abbey --- .github/ISSUE_TEMPLATE/bug_report.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 198cd92..d91975b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,13 +2,19 @@ name: Bug report about: Create a report to help us improve title: '' -labels: bug +labels: question assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +The majority of bug reports submitted are solved without changes to the Garmin application's code. This means that reporters are too often keen to attribute their issue to a problem with the application instead of: +1. Their own lack of reading documentation +2. Their own infrastructure + +Therefore in the first place make your report as if it were a **question** in order to establish if the authors agree there is really a bug! + +**Describe your issue** +A clear and concise description of what the issue is. **IMPORTANT!** I have: @@ -17,8 +23,9 @@ I have: - [ ] Checked that my JSON Syntax is correct ([options 2, 3, or 4](https://github.com/house-of-abbey/GarminHomeAssistant#editing-the-json-file) or otherwise) - [ ] Checked that my JSON follows the schema ([options 2, 3, or 4](https://github.com/house-of-abbey/GarminHomeAssistant#editing-the-json-file)) - [ ] Used the online editor to check my JSON against HomeAssistant ([option 1](https://github.com/house-of-abbey/GarminHomeAssistant#editing-the-json-file)) -- [ ] Checked the [Docs](https://github.com/house-of-abbey/GarminHomeAssistant) -- [ ] Checked the [Troubleshooting Guide](https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/TroubleShooting.md) +- [ ] Read the [Documentation](https://github.com/house-of-abbey/GarminHomeAssistant) +- [ ] Run through the [Troubleshooting Guide](https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/TroubleShooting.md) +- [ ] Checked the [Known Issues](https://github.com/house-of-abbey/GarminHomeAssistant?tab=readme-ov-file#known-issues), i.e. the problems beyond the control of this Garmin application and must therefore be tolerated! **To Reproduce** Steps to reproduce the behavior: