mirror of
https://github.com/house-of-abbey/GarminHomeAssistant.git
synced 2026-04-17 17:24:23 +00:00
Updated bug report template to clarify issue attribution and wording. Signed-off-by: Philip Abbey <philipabbey@users.noreply.github.com>
55 lines
2.1 KiB
Markdown
55 lines
2.1 KiB
Markdown
---
|
|
name: Bug report
|
|
about: Create a report to help us improve
|
|
title: ''
|
|
labels: question
|
|
assignees: ''
|
|
|
|
---
|
|
|
|
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:
|
|
|
|
- [ ] Used HTTPS to access HomeAssistant (with a public certificate)
|
|
- [ ] 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))
|
|
- [ ] 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:
|
|
|
|
1. Go to '...'
|
|
2. Click on '....'
|
|
3. Scroll down to '....'
|
|
4. See error
|
|
|
|
**Expected behavior**
|
|
A clear and concise description of what you expected to happen.
|
|
|
|
**Screenshots**
|
|
If applicable, add screenshots to help explain your problem.
|
|
|
|
**Garmin Device (please complete the following information):**
|
|
|
|
- Model: [e.g. Venu 2]
|
|
|
|
**Smartphone (please complete the following information):**
|
|
|
|
- Device: [e.g. iPhone6]
|
|
- OS: [e.g. iOS8.1]
|
|
|
|
**Additional context**
|
|
Add any other context about the problem here.
|