Skip to content

Commit ba30db3

Browse files
chore(issues): add more issue templates
Now added: `build`, `perf`, and `test` issues.
1 parent 6e2ae64 commit ba30db3

6 files changed

Lines changed: 357 additions & 49 deletions

File tree

.github/ISSUE_TEMPLATE/01-bug.yaml

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ body:
1111
attributes:
1212
label: What happened?
1313
description: Also tell us, what did you expect to happen?
14-
placeholder: Tell us what you see!
14+
placeholder: Explain the reason you're creating this issue...
1515
value: "A bug happened!"
1616
validations:
1717
required: true
@@ -32,22 +32,55 @@ body:
3232
automatically formatted into code, so no need for backticks.
3333
render: shell
3434
- type: checkboxes
35-
id: code-of-conduct
35+
id: sanity-check
3636
attributes:
37-
label: Code of Conduct
38-
description: >
39-
By submitting this issue, you agree to follow our Code of Conduct, see
40-
CODE_OF_CONDUCT.md for more details.
37+
label: I assert this issue is relevant
38+
description: |
39+
By submitting this issue you assert that:
40+
(1) you agree to follow our Code of Conduct, see CODE_OF_CONDUCT.md for
41+
more details.
42+
(2) that you've searched for similar issues and found no issues that
43+
described the same issues as this one
44+
(3) This is an actual bug and not a request for support.
45+
(4) this issue is not about a security venerability. See SECURITY.md
46+
for more information
4147
options:
42-
- label: I agree to follow this project's Code of Conduct
48+
- label: >
49+
I assert that I have read the [Code of
50+
Conduct](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/blob/main/CODE_OF_CONDUCT.md)
51+
and agree to abide by it.
4352
required: true
44-
- type: checkboxes
45-
id: no-similar
46-
attributes:
47-
label: No similar issues
48-
description: >
49-
I've searched for similar issues and found no issues that described the
50-
same issues as this one
51-
options:
52-
- label: I've searched for similar issues and found none.
53+
- label: >
54+
I assert that this is not a [duplicate of an existing
55+
issue](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=label%3A%22fix%22).
5356
required: true
57+
- label: >
58+
I assert that this is a bug and not a support request.
59+
required: true
60+
- label: >
61+
I assert that this is a bug and not a security venerability. See [
62+
SECURITY.md](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/blob/main/SECURITY.md)
63+
for more information
64+
required: true
65+
- type: "markdown"
66+
attributes:
67+
value: |
68+
### Thank you for filling out this issue!
69+
70+
---
71+
- type: "textarea"
72+
id: "prioritisation"
73+
attributes:
74+
label: "Is this issue important to you?"
75+
description: |
76+
**Please do not modify this text area!**
77+
This template helps developers know which issues should be prioritised
78+
by allowing users to vote with a :+1: reaction. This is not a guarantee
79+
that highly-requested issues will be fixed first, but it helps us to
80+
figure out what's important to users. Please react on other users'
81+
issues if you find them important.
82+
value: |
83+
Add a :+1: [reaction] to [issues you find important].
84+
85+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
86+
[issues you find important]: https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc

.github/ISSUE_TEMPLATE/02-feat.yaml

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,51 @@ body:
1111
attributes:
1212
label: What do you want to request?
1313
description: Feel free to give suggestions on how we might implement this?
14+
placeholder: Explain the reason you're creating this issue...
1415
validations:
1516
required: true
1617
- type: checkboxes
17-
id: code-of-conduct
18+
id: sanity-check
1819
attributes:
19-
label: Code of Conduct
20-
description: >
21-
By submitting this issue, you agree to follow our Code of Conduct, see
22-
CODE_OF_CONDUCT.md for more details.
20+
label: I assert this issue is relevant
21+
description: |
22+
By submitting this issue you assert that:
23+
(1) you agree to follow our Code of Conduct, see CODE_OF_CONDUCT.md for
24+
more details.
25+
(2) that you've searched for similar issues and found no issues that
26+
described the same issues as this one
27+
(3) This is an actual bug and not a request for support.
28+
(4) this issue is not about a security venerability. See SECURITY.md
29+
for more information
2330
options:
24-
- label: I agree to follow this project's Code of Conduct
31+
- label: >
32+
I assert that I have read the [Code of
33+
Conduct](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/blob/main/CODE_OF_CONDUCT.md)
34+
and agree to abide by it.
2535
required: true
26-
- type: checkboxes
27-
id: no-similar
28-
attributes:
29-
label: No similar issues
30-
description: >
31-
I've searched for similar issues and found no issues that described the
32-
same issues as this one
33-
options:
34-
- label: I've searched for similar issues and found none.
36+
- label: >
37+
I assert that this is not a [duplicate of an existing
38+
issue](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=label%3A%22feat%22).
3539
required: true
40+
- type: "markdown"
41+
attributes:
42+
value: |
43+
### Thank you for filling out this issue!
44+
45+
---
46+
- type: "textarea"
47+
id: "prioritisation"
48+
attributes:
49+
label: "Is this issue important to you?"
50+
description: |
51+
**Please do not modify this text area!**
52+
This template helps developers know which issues should be prioritised
53+
by allowing users to vote with a :+1: reaction. This is not a guarantee
54+
that highly-requested issues will be fixed first, but it helps us to
55+
figure out what's important to users. Please react on other users'
56+
issues if you find them important.
57+
value: |
58+
Add a :+1: [reaction] to [issues you find important].
59+
60+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
61+
[issues you find important]: https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc
Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Documentation Request
1+
name: Documentation issue
22
description: Request additions, updates, or improvements to the documentation.
33
title: "docs: "
44
labels: ["docs"]
@@ -12,30 +12,52 @@ body:
1212
- type: textarea
1313
id: request
1414
attributes:
15-
label: Documentation request
15+
label: Documentation issue
1616
description: >
1717
Describe what documentation is missing, outdated, or unclear. Include
1818
any suggested changes if relevant.
19-
placeholder: Explain the documentation change you would like to see.
19+
placeholder: Explain the reason you're creating this issue...
2020
validations:
2121
required: true
2222
- type: checkboxes
23-
id: code-of-conduct
23+
id: sanity-check
2424
attributes:
25-
label: Code of Conduct
26-
description: >
27-
By submitting this issue, you agree to follow our Code of Conduct, see
28-
CODE_OF_CONDUCT.md for more details.
25+
label: I assert this issue is relevant
26+
description: |
27+
By submitting this issue you assert that:
28+
(1) you agree to follow our Code of Conduct, see CODE_OF_CONDUCT.md for
29+
more details.
30+
(2) that you've searched for similar issues and found no issues that
31+
described the same issues as this one
2932
options:
30-
- label: I agree to follow this project's Code of Conduct
33+
- label: >
34+
I assert that I have read the [Code of
35+
Conduct](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/blob/main/CODE_OF_CONDUCT.md)
36+
and agree to abide by it.
3137
required: true
32-
- type: checkboxes
33-
id: no-similar
34-
attributes:
35-
label: No similar issues
36-
description: >
37-
I've searched for similar issues and found no issues that described the
38-
same issues as this one
39-
options:
40-
- label: I've searched for similar issues and found none.
38+
- label: >
39+
I assert that this is not a [duplicate of an existing
40+
issue](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=label%3A%22docs%22).
4141
required: true
42+
- type: "markdown"
43+
attributes:
44+
value: |
45+
### Thank you for filling out this issue!
46+
47+
---
48+
- type: "textarea"
49+
id: "prioritisation"
50+
attributes:
51+
label: "Is this issue important to you?"
52+
description: |
53+
**Please do not modify this text area!**
54+
This template helps developers know which issues should be prioritised
55+
by allowing users to vote with a :+1: reaction. This is not a guarantee
56+
that highly-requested issues will be fixed first, but it helps us to
57+
figure out what's important to users. Please react on other users'
58+
issues if you find them important.
59+
value: |
60+
Add a :+1: [reaction] to [issues you find important].
61+
62+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
63+
[issues you find important]: https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Build issue / suggestion
2+
description: Request additions, updates, or improvements to the build process.
3+
title: "build: "
4+
labels: ["build"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Thank you for taking the time to submit a build issue / suggestion.
10+
Please provide clear and concise details to help us address it
11+
efficiently.
12+
- type: textarea
13+
id: request
14+
attributes:
15+
label: Build issue / suggestion
16+
description: >
17+
Describe what is broken, or could be improved.
18+
Include any suggested changes if relevant.
19+
placeholder: Explain the reason you're creating this issue...
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: version
24+
attributes:
25+
label: Version
26+
description: What version are you running?
27+
placeholder: '0.0.0'
28+
validations:
29+
required: true
30+
- type: checkboxes
31+
id: sanity-check
32+
attributes:
33+
label: I assert this issue is relevant
34+
description: |
35+
By submitting this issue you assert that:
36+
(1) you agree to follow our Code of Conduct, see CODE_OF_CONDUCT.md for
37+
more details.
38+
(2) that you've searched for similar issues and found no issues that
39+
described the same issues as this one
40+
(3) This is an actual issue and not a request for support.
41+
options:
42+
- label: >
43+
I assert that I have read the [Code of
44+
Conduct](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/blob/main/CODE_OF_CONDUCT.md)
45+
and agree to abide by it.
46+
required: true
47+
- label: >
48+
I assert that this is not a [duplicate of an existing
49+
issue](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=label%3A%22build%22).
50+
required: true
51+
- label: >
52+
I assert that this is a bug and not a support request.
53+
required: true
54+
- type: "markdown"
55+
attributes:
56+
value: |
57+
### Thank you for filling out this issue!
58+
59+
---
60+
- type: "textarea"
61+
id: "prioritisation"
62+
attributes:
63+
label: "Is this issue important to you?"
64+
description: |
65+
**Please do not modify this text area!**
66+
This template helps developers know which issues should be prioritised
67+
by allowing users to vote with a :+1: reaction. This is not a guarantee
68+
that highly-requested issues will be fixed first, but it helps us to
69+
figure out what's important to users. Please react on other users'
70+
issues if you find them important.
71+
value: |
72+
Add a :+1: [reaction] to [issues you find important].
73+
74+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
75+
[issues you find important]: https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Performance issues / improvements
2+
description: Point out performance issues, or suggest areas for improvement.
3+
title: "perf: "
4+
labels: ["perf"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
Thank you for taking the time to submit a performance issue / improvement.
10+
Please provide clear and concise details to help us address it
11+
efficiently.
12+
- type: textarea
13+
id: request
14+
attributes:
15+
label: Performance issue / improvement
16+
description: >
17+
Describe what is being slow, or could be improved.
18+
Include any suggested changes if relevant.
19+
placeholder: Explain the reason you're creating this issue...
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: version
24+
attributes:
25+
label: Version
26+
description: What version are you running?
27+
placeholder: '0.0.0'
28+
validations:
29+
required: true
30+
- type: checkboxes
31+
id: sanity-check
32+
attributes:
33+
label: I assert this issue is relevant
34+
description: |
35+
By submitting this issue you assert that:
36+
(1) you agree to follow our Code of Conduct, see CODE_OF_CONDUCT.md for
37+
more details.
38+
(2) that you've searched for similar issues and found no issues that
39+
described the same issues as this one
40+
(3) This is an actual issue and not a request for support.
41+
options:
42+
- label: >
43+
I assert that I have read the [Code of
44+
Conduct](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/blob/main/CODE_OF_CONDUCT.md)
45+
and agree to abide by it.
46+
required: true
47+
- label: >
48+
I assert that this is not a [duplicate of an existing
49+
issue](https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=label%3A%22perf%22).
50+
required: true
51+
- label: >
52+
I assert that this is a bug and not a support request.
53+
required: true
54+
- type: "markdown"
55+
attributes:
56+
value: |
57+
### Thank you for filling out this issue!
58+
59+
---
60+
- type: "textarea"
61+
id: "prioritisation"
62+
attributes:
63+
label: "Is this issue important to you?"
64+
description: |
65+
**Please do not modify this text area!**
66+
This template helps developers know which issues should be prioritised
67+
by allowing users to vote with a :+1: reaction. This is not a guarantee
68+
that highly-requested issues will be fixed first, but it helps us to
69+
figure out what's important to users. Please react on other users'
70+
issues if you find them important.
71+
value: |
72+
Add a :+1: [reaction] to [issues you find important].
73+
74+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
75+
[issues you find important]: https://github.com/Tygo-van-den-Hurk/Snowflake-v2-Firmware/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc

0 commit comments

Comments
 (0)