diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 00000000000..f326139ba4a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,53 @@ +--- +name: Bug report +about: Report an issue with Home Assistant +--- + +## The problem + + + +## Environment + + +- Home Assistant release with the issue: +- Last working Home Assistant release (if known): +- Operating environment (Hass.io/Docker/Windows/etc.): +- Integration causing this issue: +- Link to integration documentation on our website: + +## Problem-relevant `configuration.yaml` + + +```yaml + +``` + +## Traceback/Error logs + + +```txt + +``` + +## Additional information + diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 885164d7a34..00000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - - - -**Home Assistant release with the issue:** - - - -**Last working Home Assistant release (if known):** - - -**Operating environment (Hass.io/Docker/Windows/etc.):** - - -**Integration:** - - - -**Description of problem:** - - - -**Problem-relevant `configuration.yaml` entries and (fill out even if it seems unimportant):** -```yaml - -``` - -**Traceback (if applicable):** -``` - -``` - -**Additional information:** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..19dd772c4e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: false +contact_links: + - name: Report a bug with the UI, Frontend or Lovelace + url: https://github.com/home-assistant/home-assistant-polymer/issues + about: This is the issue tracker for our backed. Please report issues with the UI in the frontend repository. + - name: Report incorrect/missing information on our website + urls: https://github.com/home-assistant/home-assistant.io/issues + about: Our documentation has its own issue tracker. Please report issues with the website there. + - name: I have a question or need support + url: https://www.home-assistant.io/help + about: We use GitHub for tracking bugs, check our website for resources on getting help. + - name: Feature Request + url: https://community.home-assistant.io/c/feature-requests + about: Please use our Community Forum for making feature requests. + - name: I'm unsure where to go + url: https://www.home-assistant.io/join-chat + about: If you are unsure where to go, then joining our chat is recommended; Just ask! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 474dff86b3d..4951ae1a0c0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,35 +1,91 @@ -## Breaking Change: - - - -## Description: +## Breaking change + -**Related issue (if applicable):** fixes # +## Proposed change + -**Pull request with documentation for [home-assistant.io](https://github.com/home-assistant/home-assistant.io) (if applicable):** home-assistant/home-assistant.io# -## Example entry for `configuration.yaml` (if applicable): +## Type of change + + +- [ ] 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) +- [ ] Code quality improvements to existing code or addition of tests + +## Example entry for `configuration.yaml`: + + ```yaml ``` -## Checklist: - - [ ] The code change is tested and works locally. - - [ ] Local tests pass with `tox`. **Your PR cannot be merged unless tests pass** - - [ ] There is no commented out code in this PR. - - [ ] I have followed the [development checklist][dev-checklist] +## Additional information + + +- This PR fixes or closes issue: fixes # +- This PR is related to issue: +- Link to documentation pull request: + +## Checklist + + +- [ ] The code change is tested and works locally. +- [ ] Local tests pass. **Your PR cannot be merged unless tests pass** +- [ ] There is no commented out code in this PR. +- [ ] I have followed the [development checklist][dev-checklist] +- [ ] The code has been formatted using Black (`black --fast homeassistant tests`) +- [ ] Tests have been added to verify that the new code works. If user exposed functionality or configuration variables are added/changed: - - [ ] Documentation added/updated in [home-assistant.io](https://github.com/home-assistant/home-assistant.io) + +- [ ] Documentation added/updated in [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`. - - [ ] Untested files have been added to `.coveragerc`. -If the code does not interact with devices: - - [ ] Tests have been added to verify that the new code works. +- [ ] [_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`. +- [ ] Untested files have been added to `.coveragerc`. + +The integration reached or maintains the following Integration 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 +[docs-repository]: https://github.com/home-assistant/home-assistant.io