mirror of
https://github.com/house-of-abbey/GarminHomeAssistant.git
synced 2026-04-17 19:24:24 +00:00
Revise bug report template for clarity
Updated bug report template to clarify issue attribution and wording. Signed-off-by: Philip Abbey <philipabbey@users.noreply.github.com>
This commit is contained in:
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -2,13 +2,19 @@
|
|||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Create a report to help us improve
|
||||||
title: ''
|
title: ''
|
||||||
labels: bug
|
labels: question
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
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:
|
||||||
A clear and concise description of what the bug is.
|
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!**
|
**IMPORTANT!**
|
||||||
I have:
|
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 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))
|
- [ ] 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))
|
- [ ] 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)
|
- [ ] Read the [Documentation](https://github.com/house-of-abbey/GarminHomeAssistant)
|
||||||
- [ ] Checked the [Troubleshooting Guide](https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/TroubleShooting.md)
|
- [ ] 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**
|
**To Reproduce**
|
||||||
Steps to reproduce the behavior:
|
Steps to reproduce the behavior:
|
||||||
|
|||||||
Reference in New Issue
Block a user