Skip to content

Commit edc5c40

Browse files
committed
Add issue and PR templates to streamline contribution
1 parent 30a597b commit edc5c40

3 files changed

Lines changed: 126 additions & 0 deletions

File tree

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Bug Report
2+
about: Create a report to help us improve the integration.
3+
title: "[BUG]"
4+
labels:
5+
- bug
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to file an issue! Please fill out the form below so we can investigate and fix your problem.
12+
- type: input
13+
id: summary
14+
attributes:
15+
label: Summary of the bug
16+
description: A short, descriptive title for the issue
17+
placeholder: e.g., "OpenTherm gateway disconnects after restart"
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to reproduce
24+
description: Detailed steps that lead to the bug.
25+
placeholder: |
26+
1. Open Home Assistant
27+
2. ...
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: expected_behavior
32+
attributes:
33+
label: Expected behavior
34+
description: What you expected to happen.
35+
validations:
36+
required: false
37+
- type: textarea
38+
id: actual_behavior
39+
attributes:
40+
label: Actual behavior
41+
description: What actually happened.
42+
validations:
43+
required: true
44+
- type: input
45+
id: homeassistant_version
46+
attributes:
47+
label: Home Assistant version
48+
description: The version of Home Assistant you are using.
49+
placeholder: e.g., 2024.1.0
50+
validations:
51+
required: true
52+
- type: input
53+
id: integration_version
54+
attributes:
55+
label: Integration version
56+
description: The commit or tag of the SAT integration.
57+
placeholder: e.g., v1.2.3 or HEAD
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: logs
62+
attributes:
63+
label: Relevant logs
64+
description: Paste any relevant log snippets (e.g., from config entries). Use triple backticks.
65+
render: shell
66+
validations:
67+
required: false
68+
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Feature Request
2+
about: Suggest a new feature or improvement.
3+
title: "[FEATURE]"
4+
labels:
5+
- enhancement
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for helping us improve SAT! Please describe the feature you’d like to see.
12+
- type: input
13+
id: summary
14+
attributes:
15+
label: Feature Summary
16+
description: One‑sentence description of the requested feature.
17+
placeholder: e.g., "Add support for XYZ boiler model"
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: rationale
22+
attributes:
23+
label: Rationale
24+
description: Why is this feature valuable? Who will benefit?
25+
validations:
26+
required: false
27+
- type: textarea
28+
id: implementation_ideas
29+
attributes:
30+
label: Implementation Ideas
31+
description: Any thoughts on how to implement it or potential challenges.
32+
validations:
33+
required: false
34+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
This file is used as the default template for pull requests.
3+
It provides a checklist that ensures new contributions follow project conventions.
4+
-->
5+
6+
# Pull Request Template
7+
8+
## Summary
9+
- [ ] I have added a clear, concise title and description.
10+
- [ ] The description includes what has changed and why it matters.
11+
12+
## Checklist
13+
- [ ] I followed the coding style guidelines (PEP8, Home Assistant patterns).
14+
- [ ] All new code is typed with type hints where appropriate.
15+
- [ ] I added or updated unit tests that cover my changes.
16+
- [ ] Tests run locally and on CI without errors.
17+
- [ ] Documentation updates (README, docs, comments) are included if relevant.
18+
19+
## Screenshots / Visuals
20+
(Add screenshots if the PR introduces UI changes.)
21+
22+
## Additional Notes
23+
(Any extra information for reviewers.)
24+

0 commit comments

Comments
 (0)