Skip to content

Commit f88bd23

Browse files
committed
feat: add GitHub issue templates for bug reports, documentation improvements, and feature requests.
1 parent cff426f commit f88bd23

3 files changed

Lines changed: 149 additions & 0 deletions

File tree

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug Report
2+
description: Create a report to help us improve HA WashData
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the Bug
15+
description: A clear and concise description of what the bug is.
16+
placeholder: "When I engage the flux capacitor, the washing machine assumes it's a coffee maker..."
17+
validations:
18+
required: true
19+
20+
- type: input
21+
id: version
22+
attributes:
23+
label: Integration Version
24+
description: What version of HA WashData are you running?
25+
placeholder: "v0.3.1"
26+
validations:
27+
required: true
28+
29+
- type: input
30+
id: ha_version
31+
attributes:
32+
label: Home Assistant Version
33+
description: What version of Home Assistant Core are you running?
34+
placeholder: "2024.12.0"
35+
validations:
36+
required: false
37+
38+
- type: textarea
39+
id: reproduction
40+
attributes:
41+
label: Reproduction Steps
42+
description: Steps to reproduce the behavior.
43+
placeholder: |
44+
1. Go to '...'
45+
2. Click on '...'
46+
3. Scroll down to '...'
47+
4. See error
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: expected
53+
attributes:
54+
label: Expected Behavior
55+
description: A clear and concise description of what you expected to happen.
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: debug_log
61+
attributes:
62+
label: Debug LOG
63+
description: |
64+
Please enable debug logging for `custom_components.ha_washdata` and `custom_components.ha_washdata.profile_store`.
65+
66+
To enable via YAML:
67+
```yaml
68+
logger:
69+
default: info
70+
logs:
71+
custom_components.ha_washdata: debug
72+
```
73+
render: shell
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Documentation Improvement
2+
description: Suggest a change to the documentation
3+
title: "[DOCS] "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our docs!
10+
11+
- type: input
12+
id: page
13+
attributes:
14+
label: Page / Section
15+
description: Which page or section of the documentation needs improvement?
16+
placeholder: "README.md -> Configuration"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: wrong
22+
attributes:
23+
label: What is wrong / missing?
24+
description: Description of the inaccuracy or missing information.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: suggestion
30+
attributes:
31+
label: Suggested Change
32+
description: If possible, propose the new text or clear structure for the change.
33+
validations:
34+
required: false
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[FR] "
4+
labels: ["feature request"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new idea!
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Is your feature request related to a problem? Please describe.
15+
description: A clear and concise description of what the problem is.
16+
placeholder: "I'm always frustrated when..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Describe the solution you'd like
24+
description: A clear and concise description of what you want to happen.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Describe alternatives you've considered
32+
description: A clear and concise description of any alternative solutions or features you've considered.
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
id: context
38+
attributes:
39+
label: Additional context
40+
description: Add any other context or screenshots about the feature request here.
41+
validations:
42+
required: false

0 commit comments

Comments
 (0)