Skip to content

Commit

Permalink
added bug/enhancement templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jumping2000 committed Sep 1, 2023
1 parent 86d029b commit 8c06c8c
Show file tree
Hide file tree
Showing 2 changed files with 131 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/packages-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: Packages Bug Report
description: Create a bug report for a package included in our collection.
title: 'Bug - '
labels:
- package
- bug
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report here! :tada:
Please do not delete any part of the template, since keeping the provided structure will help maintainers to process your request more rapidly.
This template should only be used to report a bug with a package. If this is not your case, you can [choose a different issue template](https://github.com/jumping2000/ha-templates/issues/new/choose).
- type: input
attributes:
label: package name
description: The name of the package you're opening this issue for.
validations:
required: true
- type: input
attributes:
label: Home Assistant Core Version
description: The Home Assistant Core Version installed on the system you're experiencing issues with.
placeholder: e.g. 2020.12.0
validations:
required: true
- type: dropdown
attributes:
label: Home Assistant Installation Type
options:
- Home Assistant Operating System
- Home Assistant Container
- Home Assistant Supervised
- Home Assistant Core
validations:
required: true
- type: textarea
attributes:
label: Description
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Automation YAML config
description: The YAML code for the automation you're having problems with. This will allow to reproduce your issue.
render: yaml
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the issue
value: |
1. Go to '...'
2. Click on '....'
3. Trigger the automation '....'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Behaviour
description: A clear and concise description of what it's actually happening, in contrast with the expected behaviour.
validations:
required: true
- type: checkboxes
attributes:
label: Additional Details
options:
- label: I'd like to help developing a fix for this issue.
- type: textarea
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/packages-enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Packages Enhancement
description: Propose a new feature/improvement for an existing package
title: 'Enhancement - '
labels:
- package
- enhancement
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report here! :tada:
Please do not delete any part of the template, since keeping the provided structure will help maintainers to process your request more rapidly.
This template should only be used to propose a new feature or enhancement for an existing package. If this is not your case, you can [choose a different issue template](https://github.com/jumping2000/ha-templates/issues/new/choose).
- type: input
attributes:
label: package name
description: The name of the package you're opening this issue for.
validations:
required: true
- type: textarea
attributes:
label: Description
description: A clear and concise description of what the enhancement or new feature consists of.
validations:
required: true
- type: textarea
attributes:
label: Implementation
description: If you've an idea on how this could be implemented, post here an informal description of the steps necessary for reaching the wanted goal.
- type: checkboxes
attributes:
label: Additional Details
options:
- label: I'd like to help developing this feature/improvement.
- type: textarea
attributes:
label: Useful resources
description: Any package/automation or resource not included in this project which achieves the same/similar goal. Include links/references to them.
- type: textarea
attributes:
label: Additional context
description: Add any other context about the new package here (corner cases which should be handled, different approaches which can be considered, etc.).

0 comments on commit 8c06c8c

Please sign in to comment.