Skip to content

Commit

Permalink
Add bug and feature request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
klejejs committed Dec 5, 2024
1 parent 53b765a commit 7a2b593
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bug report
description: Create a bug report for something that is not working as expected
title: "Bug: "
labels:
- bug
- needs-triage
assignees:
- klejejs

body:
- type: textarea
id: issue
validations:
required: true
attributes:
label: Issue
description: A clear and concise description of what the bug is.

- type: textarea
id: expected_behavior
validations:
required: true
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.

- type: textarea
id: debug_file_data
validations:
required: true
attributes:
label: Debug File Data
description: Please attach Thermia debug file data that can help diagnose the issue. To get the debug file data, see [README.md](https://github.com/klejejs/ha-thermia-heat-pump-integration?tab=readme-ov-file#adding-support-for-new-heat-pump-models).

- type: checkboxes
id: latest_version
attributes:
label: Are you running the latest version?
description: Please check if you are running the latest version of the integration before submitting a bug report.
options:
- label: I have checked and am running the latest version of the integration
required: true

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context about the problem here.
placeholder: Add additional context here
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature request
description: Suggest a new feature or improvement
title: "Feature: "
labels:
- enhancement
- needs-triage
assignees:
- klejejs

body:
- type: textarea
id: problem
validations:
required: true
attributes:
label: Problem
description: A clear and concise description of what the problem is.

- type: textarea
id: solution
validations:
required: true
attributes:
label: Solution
description: A clear and concise description of what you want to happen.

- type: textarea
id: alternatives
validations:
required: true
attributes:
label: Alternatives
description: A clear and concise description of any alternative solutions or features you've considered.

- type: textarea
id: debug_file_data
validations:
required: true
attributes:
label: Debug File Data
description: Please attach Thermia debug file data that can help diagnose the issue. To get the debug file data, see [README.md](https://github.com/klejejs/ha-thermia-heat-pump-integration?tab=readme-ov-file#adding-support-for-new-heat-pump-models).

- type: checkboxes
id: latest_version
attributes:
label: Are you running the latest version?
description: Please check if you are running the latest version of the integration before submitting a bug report.
options:
- label: I have checked and am running the latest version of the integration
required: true

- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Discussions
url: https://github.com/klejejs/ha-thermia-heat-pump-integration/discussions
about: In case you have any questions or need help with the integration, please use GitHub Discussions.

0 comments on commit 7a2b593

Please sign in to comment.