diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 116afec36ee..ac4c8453327 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -15,7 +15,7 @@ body: attributes: label: The problem description: >- - Describe the issue you are experiencing here to communicate to the + Describe the issue you are experiencing here, to communicate to the maintainers. Tell us what you were trying to do and what happened. Provide a clear and concise description of what the problem is. @@ -28,10 +28,12 @@ body: validations: required: true attributes: - label: What is version of Home Assistant Core has the issue? + label: What version of Home Assistant Core has the issue? placeholder: core- description: > - Can be found in the Configuration panel -> Info. + Can be found in: [Configuration panel -> Info](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/) - type: input attributes: label: What was the last working version of Home Assistant Core? @@ -44,7 +46,9 @@ body: attributes: label: What type of installation are you running? description: > - If you don't know, you can find it in: Configuration panel -> Info. + Can be found in: [Configuration panel -> Info](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/) options: - Home Assistant OS - Home Assistant Container @@ -55,15 +59,15 @@ body: attributes: label: Integration causing the issue description: > - The name of the integration, for example, Automation or Philips Hue. + The name of the integration. For example: Automation, Philips Hue - type: input id: integration_link attributes: label: Link to integration documentation on our website placeholder: "https://www.home-assistant.io/integrations/..." description: | - Providing a link [to the documentation][docs] help us categorizing the - issue, while providing a useful reference at the same time. + Providing a link [to the documentation][docs] helps us categorize the + issue, while also providing a useful reference for others. [docs]: https://www.home-assistant.io/integrations @@ -75,8 +79,8 @@ body: attributes: label: Example YAML snippet description: | - If this issue has an example piece of YAML that can help reproducing this problem, please provide. - This can be an piece of YAML from, e.g., an automation, script, scene or configuration. + 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 - type: textarea attributes: @@ -88,5 +92,3 @@ body: label: Additional information description: > If you have any additional information for us, use the field below. - Please note, you can attach screenshots or screen recordings here, by - dragging and dropping files in the field below.