Skip to content

Commit c40b84d

Browse files
huizebruinhuizebruin
committed
New issue template forms
New issue template forms, with fields and labels
1 parent ddb4467 commit c40b84d

File tree

6 files changed

+130
-56
lines changed

6 files changed

+130
-56
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

-36
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yaml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: "Bug report"
2+
description: "Create a bug report to help us improve the S0tool!"
3+
labels: ["bug", "question", "triage:not-checked"]
4+
body:
5+
- type: checkboxes
6+
id: no-duplicate-issues
7+
attributes:
8+
label: "Please verify that this bug has NOT been raised before."
9+
description: "Search in the issues sections by clicking [HERE](https://github.com//huizebruin/s0tool/issues?q=) and read the [Discussions](https://github.com/huizebruin/s0tool/discussions)!"
10+
options:
11+
- label: "I checked and didn't find a similar issue"
12+
required: true
13+
- type: textarea
14+
id: description
15+
validations:
16+
required: true
17+
attributes:
18+
label: "Describe the bug*"
19+
description: "A clear and concise description of what the bug is."
20+
- type: textarea
21+
id: expected-behavior
22+
validations:
23+
required: true
24+
attributes:
25+
label: "Expected behaviour"
26+
description: "A clear and concise description of what you expected to happen."
27+
placeholder: "..."
28+
- type: textarea
29+
id: version-info
30+
validations:
31+
required: true
32+
attributes:
33+
label: "Version Information"
34+
description: "The version info block."
35+
placeholder: "Please post S0tool version / ESPHome version / Home Assistant version "
36+
- type: textarea
37+
id: ESPHome-version-info
38+
validations:
39+
required: true
40+
attributes:
41+
label: "ESPHome version Information"
42+
description: "The version info block."
43+
placeholder: "Please post ESPHome version"
44+
- type: textarea
45+
id: Home Assistant-version-info
46+
validations:
47+
required: true
48+
attributes:
49+
label: "Home Assistant version Information"
50+
description: "The version info block."
51+
placeholder: "Please post Home Assistant version "
52+
53+
- type: textarea
54+
id: Additional-context
55+
validations:
56+
required: true
57+
attributes:
58+
label: "Additional context"
59+
description: "Add any other context about the problem here."
60+
placeholder: "Add any other context about the problem here. "
61+

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: "Documentation"
2+
description: "Create an issue to improve the documentation"
3+
labels: ["documentation", "triage:not-checked"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Create a new issue regarding the S0tool documentation
9+
- type: textarea
10+
id: repro
11+
attributes:
12+
label: Body of the issue
13+
description: Please provide one distinct thing to fix or a clearly defined enhancement
14+
validations:
15+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md

-20
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yaml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[FR] title"
4+
labels: ["enhancement", "triage:not-checked"]
5+
body:
6+
- type: checkboxes
7+
id: no-duplicate-issues
8+
attributes:
9+
label: "Please verify that this feature request has NOT been suggested before."
10+
description: "Search in the issues sections by clicking [HERE](https://github.com/huizebruin/s0tool/issues?q=)"
11+
options:
12+
- label: "I checked and didn't find a similar feature request"
13+
required: true
14+
- type: textarea
15+
id: problem
16+
validations:
17+
required: true
18+
attributes:
19+
label: "Problem statement"
20+
description: "A clear and concise description of the problem or missing feature."
21+
placeholder: "I am always struggling with ..."
22+
- type: textarea
23+
id: solution
24+
validations:
25+
required: true
26+
attributes:
27+
label: "Suggested solution"
28+
description: "A clear and concise description of what you want to happen to solve the problem statement."
29+
placeholder: "In my use-case, ..."
30+
- type: textarea
31+
id: alternatives
32+
validations:
33+
required: true
34+
attributes:
35+
label: "Describe alternatives you've considered"
36+
description: "A clear and concise description of any alternative solutions or features you've considered."
37+
placeholder: "This could also be done by doing ..."
38+
- type: textarea
39+
id: examples
40+
validations:
41+
required: false
42+
attributes:
43+
label: "Examples of other systems"
44+
description: "Show how other software handles your FR if you have examples."
45+
placeholder: "I software xxx this is done in the following way..."
46+
- type: checkboxes
47+
id: self-develop
48+
attributes:
49+
label: "Do you want to develop this?"
50+
description: "This is not required, and you do not need to be a pro - this is just as information for us."
51+
options:
52+
- label: "I want to develop this."
53+
required: false

0 commit comments

Comments
 (0)