Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ufozone committed Sep 15, 2024
1 parent eed324a commit d459bb7
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 37 deletions.
93 changes: 69 additions & 24 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,49 +8,94 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! 🛠️ Please provide the details below to help us address the issue.
- type: input
id: summary
attributes:
label: Short summary 📝
description: A short summary of the bug
placeholder: "e.g., The application crashes when I click on 'Submit'"
validations:
required: true
Thanks for taking the time to fill out this bug report! Please provide the details below to help us address the issue.
- type: textarea
id: description
attributes:
label: Detailed description 📋
description: A detailed description of the bug
label: Detailed description
description: >-
We need a detailed description of the issue. Tell us what you were trying to do and what happened.
Provide a clear and concise description of what the problem is.
placeholder: "Describe the bug in detail, including steps to reproduce, expected behavior, and actual behavior."
validations:
required: true

- type: markdown
attributes:
value: |
## Environment
- type: input
id: version
attributes:
label: Version 📌
description: The version of the application where the bug was found
placeholder: "e.g., v1.2.3"
label: What version of the integration has the issue?
placeholder: v1.0.0
description: >
Can be found in: [Settings ⇒ Devices & services ⇒ Integrations ⇒ Click on integration name](https://my.home-assistant.io/redirect/integration/?domain=octopusnet).
[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=octopusnet)
validations:
required: false
required: true
- type: input
attributes:
label: What was the last working version of the integration?
placeholder: v1.0.0
description: >
If known, otherwise leave blank.
- type: input
attributes:
label: What version of Home Assistant Core has the issue?
placeholder: core-2024.9.0
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 the system information.](https://my.home-assistant.io/badges/system_health.svg)](https://my.home-assistant.io/redirect/system_health/)
validations:
required: true
- type: input
id: environment
attributes:
label: Environment 🌐
description: The environment in which the bug was found (e.g., browser, OS)
placeholder: "e.g., Chrome on Windows 10"
label: What was the last working version of Home Assistant Core?
placeholder: core-2024.9.0
description: >
If known, otherwise leave blank.
- type: markdown
attributes:
value: |
# Details
- type: textarea
attributes:
label: Diagnostics information
description: >-
The integration provide the ability to [download diagnostic data](https://www.home-assistant.io/docs/configuration/troubleshooting/#debug-logs-and-diagnostics).
**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>**
It generally allows pinpointing defects and thus resolving issues faster.
placeholder: "Drag-and-drop the diagnostics data file here (do not copy-and-paste the content)"
validations:
required: false
- type: textarea
attributes:
label: Logs
description: Anything in the logs that might be useful for us? For example, error message, or stack traces.
render: txt
placeholder: "Paste logs"
validations:
required: false

- type: textarea
id: logs
attributes:
label: Logs and screenshots 📂
description: Any relevant logs or screenshots that can help identify the issue
placeholder: "Paste logs or upload screenshots"
label: Screenshots
description: Any relevant screenshots that can help identify the issue
placeholder: "Upload screenshots"
validations:
required: false
- type: textarea
attributes:
label: Additional information
description: If you have any additional information for us, use the field below.
validations:
required: false
17 changes: 4 additions & 13 deletions .github/ISSUE_TEMPLATE/FEAT_REQUEST.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,21 @@ body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! 🚀 Please fill out the details below to help us understand your request.
- type: input
id: title
attributes:
label: Short summary
description: A short summary of the feature request 📝
placeholder: "e.g., Add dark mode to the application"
validations:
required: true
Thanks for suggesting a new feature! Please fill out the details below to help us understand your request.
- type: textarea
id: description
attributes:
label: Detailed description
description: A detailed description of the feature request 📋
description: A detailed description of the feature request
placeholder: "Describe the feature in detail, including the problem it solves, the benefits it provides, and any additional context."
validations:
required: true

- type: input
id: examples
attributes:
label: Examples 🖼️
label: Examples
description: Any examples or mockups to help illustrate the feature
placeholder: "e.g., Provide a screenshot or a link to a similar feature"
validations:
Expand All @@ -40,7 +31,7 @@ body:
- type: input
id: additional_context
attributes:
label: Additional context 🗒️
label: Additional context
description: Any other context or information you want to provide
placeholder: "e.g., Why is this feature important to you?"
validations:
Expand Down

0 comments on commit d459bb7

Please sign in to comment.