diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index f326139ba4a..34c023c4410 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Report a bug with Home Assistant about: Report an issue with Home Assistant --- ## Breaking change ## Type of change +- [ ] Dependency upgrade - [ ] Bugfix (non-breaking change which fixes an issue) - [ ] New integration (thank you!) - [ ] New feature (which adds functionality to an existing integration) -- [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected) +- [ ] Breaking change (fix/feature causing existing functionality to break) - [ ] Code quality improvements to existing code or addition of tests ## Example entry for `configuration.yaml`: ```yaml +# Example configuration.yaml ``` ## Additional information - This PR fixes or closes issue: fixes # @@ -54,10 +61,10 @@ ## Checklist - [ ] The code change is tested and works locally. @@ -69,22 +76,33 @@ If user exposed functionality or configuration variables are added/changed: -- [ ] Documentation added/updated in [home-assistant.io][docs-repository] +- [ ] Documentation added/updated for [www.home-assistant.io][docs-repository] If the code communicates with devices, web services, or third-party tools: -- [ ] [_The manifest file_][manifest-docs] has all fields filled out correctly. Update and include derived files by running `python3 -m script.hassfest`. -- [ ] New or updated dependencies have been added to `requirements_all.txt` by running `python3 -m script.gen_requirements_all`. +- [ ] The [manifest file][manifest-docs] has all fields filled out correctly. + Updated and included derived files by running: `python3 -m script.hassfest`. +- [ ] New or updated dependencies have been added to `requirements_all.txt`. + Updated by running `python3 -m script.gen_requirements_all`. - [ ] Untested files have been added to `.coveragerc`. -The integration reached or maintains the following Integration Quality Scale: - +The integration reached or maintains the following [Integration Quality Scale][quality-scale]: + - [ ] No score or internal - [ ] 🥈 Silver - [ ] 🥇 Gold - [ ] 🏆 Platinum + [dev-checklist]: https://developers.home-assistant.io/docs/en/development_checklist.html [manifest-docs]: https://developers.home-assistant.io/docs/en/creating_integration_manifest.html [quality-scale]: https://developers.home-assistant.io/docs/en/next/integration_quality_scale_index.html