core/.github/ISSUE_TEMPLATE/bug_report.yml

106 lines
4.0 KiB
YAML
Raw Normal View History

2021-01-30 20:32:46 +00:00
name: Report an issue with Home Assistant Core
description: Report an issue with Home Assistant Core.
body:
- type: markdown
2021-01-30 20:10:42 +00:00
attributes:
value: |
This issue form is for reporting bugs only!
If you have a feature or enhancement request, please use the [feature request][fr] section of our [Community Forum][fr].
2021-01-30 20:17:36 +00:00
2021-01-30 20:10:42 +00:00
[fr]: https://community.home-assistant.io/c/feature-requests
- type: textarea
validations:
required: true
2021-01-30 20:10:42 +00:00
attributes:
label: The problem
description: >-
Describe the issue you are experiencing here, to communicate to the
2021-01-30 20:10:42 +00:00
maintainers. Tell us what you were trying to do and what happened.
Provide a clear and concise description of what the problem is.
- type: markdown
2021-01-30 20:10:42 +00:00
attributes:
value: |
## Environment
- type: input
id: version
validations:
required: true
2021-01-30 20:10:42 +00:00
attributes:
label: What version of Home Assistant Core has the issue?
2021-01-30 20:10:42 +00:00
placeholder: core-
description: >
Can be found in: [Settings -> About](https://my.home-assistant.io/redirect/info/).
[![Open your Home Assistant instance and show your Home Assistant version information.](https://my.home-assistant.io/badges/info.svg)](https://my.home-assistant.io/redirect/info/)
2021-01-30 20:10:42 +00:00
- type: input
attributes:
label: What was the last working version of Home Assistant Core?
placeholder: core-
description: >
If known, otherwise leave blank.
- type: dropdown
validations:
required: true
2021-01-30 20:10:42 +00:00
attributes:
label: What type of installation are you running?
description: >
Can be found in: [Settings -> System-> Repairs -> Three Dots in Upper Right -> System information](https://my.home-assistant.io/redirect/system_health/).
[![Open your Home Assistant instance and show health information about your system.](https://my.home-assistant.io/badges/system_health.svg)](https://my.home-assistant.io/redirect/system_health/)
options:
2021-01-30 20:10:42 +00:00
- Home Assistant OS
- Home Assistant Container
- Home Assistant Supervised
- Home Assistant Core
- type: input
id: integration_name
2021-01-30 20:10:42 +00:00
attributes:
label: Integration causing the issue
description: >
The name of the integration. For example: Automation, Philips Hue
2021-01-30 20:10:42 +00:00
- type: input
id: integration_link
2021-01-30 20:10:42 +00:00
attributes:
label: Link to integration documentation on our website
placeholder: "https://www.home-assistant.io/integrations/..."
2021-01-30 20:21:57 +00:00
description: |
Providing a link [to the documentation][docs] helps us categorize the
issue, while also providing a useful reference for others.
2021-01-30 20:10:42 +00:00
[docs]: https://www.home-assistant.io/integrations
- type: markdown
2021-01-30 20:10:42 +00:00
attributes:
value: |
# Details
2022-02-05 01:34:46 +00:00
- type: textarea
attributes:
label: Diagnostics information
placeholder: "drag-and-drop the diagnostics data file here (do not copy-and-paste the content)"
2022-02-05 01:34:46 +00:00
description: >-
Many integrations provide the ability to [download diagnostic data](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics).
2022-02-05 01:34:46 +00:00
**It would really help if you could download the diagnostics data for the device you are having issues with,
and <ins>drag-and-drop that file into the textbox below.</ins>**
2022-02-05 01:34:46 +00:00
It generally allows pinpointing defects and thus resolving issues faster.
2021-01-30 20:10:42 +00:00
- type: textarea
attributes:
label: Example YAML snippet
description: |
If applicable, please provide an example piece of YAML that can help reproduce this problem.
This can be from an automation, script, scene or configuration.
render: yaml
2021-01-30 20:10:42 +00:00
- type: textarea
attributes:
label: Anything in the logs that might be useful for us?
description: For example, error message, or stack traces.
render: txt
- type: textarea
2021-01-30 20:10:42 +00:00
attributes:
label: Additional information
description: >
2021-01-30 20:10:42 +00:00
If you have any additional information for us, use the field below.