Skip to content

Commit 8b76dd1

Browse files
klejejsklejejs
committed
Add bug and feature request templates
1 parent 29077f5 commit 8b76dd1

3 files changed

Lines changed: 176 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-bug_report.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Bug report
2+
description: Create a bug report for something that is not working as expected
3+
title: "Bug: "
4+
labels:
5+
- bug
6+
- needs-triage
7+
assignees:
8+
- klejejs
9+
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
**Describe the issue**
15+
A clear and concise description of what the bug is.
16+
17+
- type: textarea
18+
id: issue
19+
validations:
20+
required: true
21+
attributes:
22+
label: Issue
23+
description: A clear and concise description of what the bug is.
24+
25+
- type: markdown
26+
attributes:
27+
value: |
28+
**Expected behavior**
29+
A clear and concise description of what you expected to happen.
30+
31+
- type: textarea
32+
id: expected_behavior
33+
validations:
34+
required: true
35+
attributes:
36+
label: Expected Behavior
37+
description: A clear and concise description of what you expected to happen.
38+
39+
- type: markdown
40+
attributes:
41+
value: |
42+
**Debug file data**
43+
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/python-thermia-online-api?tab=readme-ov-file#regarding-unsupported-models).
44+
45+
- type: textarea
46+
id: debug_file_data
47+
validations:
48+
required: true
49+
attributes:
50+
label: Debug File Data
51+
description: Please attach Thermia debug file data that can help diagnose the issue.
52+
53+
- type: markdown
54+
attributes:
55+
value: |
56+
**Are you running the latest version?**
57+
Please check if you are running the latest version of the package before submitting a bug report.
58+
59+
- type: checkboxes
60+
id: latest_version
61+
attributes:
62+
label: Are you running the latest version?
63+
description: Please check if you are running the latest version of the package before submitting a bug report.
64+
options:
65+
- label: I have checked and am running the latest version of the package
66+
required: true
67+
68+
- type: markdown
69+
attributes:
70+
value: |
71+
**Additional context**
72+
Add any other context about the problem here.
73+
74+
- type: textarea
75+
id: additional_context
76+
attributes:
77+
label: Additional Context
78+
description: Add any other context about the problem here.
79+
placeholder: Add additional context here

‎.github/ISSUE_TEMPLATE/2-feature_request.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement
3+
title: "Feature: "
4+
labels:
5+
- enhancement
6+
- needs-triage
7+
assignees:
8+
- klejejs
9+
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
**Is your feature request related to a problem? Please describe.**
15+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
17+
- type: textarea
18+
id: problem
19+
validations:
20+
required: true
21+
attributes:
22+
label: Problem
23+
description: A clear and concise description of what the problem is.
24+
25+
- type: markdown
26+
attributes:
27+
value: |
28+
**Describe the solution you'd like**
29+
A clear and concise description of what you want to happen.
30+
31+
- type: textarea
32+
id: solution
33+
validations:
34+
required: true
35+
attributes:
36+
label: Solution
37+
description: A clear and concise description of what you want to happen.
38+
39+
- type: markdown
40+
attributes:
41+
value: |
42+
**Describe alternatives you've considered**
43+
A clear and concise description of any alternative solutions or features you've considered.
44+
45+
- type: textarea
46+
id: alternatives
47+
validations:
48+
required: true
49+
attributes:
50+
label: Alternatives
51+
description: A clear and concise description of any alternative solutions or features you've considered.
52+
53+
- type: markdown
54+
attributes:
55+
value: |
56+
**Debug file data**
57+
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/python-thermia-online-api?tab=readme-ov-file#regarding-unsupported-models).
58+
59+
- type: textarea
60+
id: debug_file_data
61+
validations:
62+
required: true
63+
attributes:
64+
label: Debug File Data
65+
description: Please attach Thermia debug file data that can help diagnose the issue.
66+
67+
- type: markdown
68+
attributes:
69+
value: |
70+
**Are you running the latest version?**
71+
Please check if you are running the latest version of the package before submitting a bug report.
72+
73+
- type: checkboxes
74+
id: latest_version
75+
attributes:
76+
label: Are you running the latest version?
77+
description: Please check if you are running the latest version of the package before submitting a bug report.
78+
options:
79+
- label: I have checked and am running the latest version of the package
80+
required: true
81+
82+
- type: markdown
83+
attributes:
84+
value: |
85+
**Additional context**
86+
Add any other context or screenshots about the feature request here.
87+
88+
- type: textarea
89+
id: additional_context
90+
attributes:
91+
label: Additional Context
92+
description: Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/klejejs/ha-thermia-heat-pump-integration/discussions
5+
about: In case you have any questions or need help with the integration, please use GitHub Discussions.

0 commit comments

Comments
 (0)