Skip to content

Commit 9ab7b86

Browse files
Tygo-van-den-HurkTygo-van-den-Hurk
committed
chore(issues): add more issue templates
Now added: `build`, `perf`, and `test` issues.
1 parent 7f58826 commit 9ab7b86

File tree

6 files changed

+230
-2
lines changed

6 files changed

+230
-2
lines changed

‎.github/ISSUE_TEMPLATE/01-bug.yaml‎

Lines changed: 1 addition & 1 deletion
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

‎.github/ISSUE_TEMPLATE/02-feat.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ 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

‎.github/ISSUE_TEMPLATE/03-docs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ body:
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

‎.github/ISSUE_TEMPLATE/04-build.yaml‎

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/Slyde/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/Slyde/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/Slyde/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc

‎.github/ISSUE_TEMPLATE/05-perf.yaml‎

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/Slyde/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/Slyde/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/Slyde/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc

‎.github/ISSUE_TEMPLATE/06-test.yaml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Test coverage issues / improvements
2+
description: >
3+
Point out issues, or suggest areas for improvement for the test coverage.
4+
title: "test: "
5+
labels: ["test"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for taking the time to submit a issue related to test
11+
coverage.
12+
Please provide clear and concise details to help us address it
13+
efficiently.
14+
- type: textarea
15+
id: request
16+
attributes:
17+
label: Test coverage issues / improvements
18+
description: >
19+
Describe what is not being tested, but should be. Include any suggested
20+
changes if relevant like perhaps a failing custom test case.
21+
placeholder: Explain the reason you're creating this issue...
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: version
26+
attributes:
27+
label: Version
28+
description: What version are you running?
29+
placeholder: '0.0.0'
30+
validations:
31+
required: true
32+
- type: checkboxes
33+
id: sanity-check
34+
attributes:
35+
label: I assert this issue is relevant
36+
description: |
37+
By submitting this issue you assert that:
38+
(1) you agree to follow our Code of Conduct, see CODE_OF_CONDUCT.md for
39+
more details.
40+
(2) that you've searched for similar issues and found no issues that
41+
described the same issues as this one
42+
(3) This is an actual issue and not a request for support.
43+
options:
44+
- label: >
45+
I assert that I have read the [Code of
46+
Conduct](https://github.com/Tygo-van-den-Hurk/Slyde/blob/main/CODE_OF_CONDUCT.md)
47+
and agree to abide by it.
48+
required: true
49+
- label: >
50+
I assert that this is not a [duplicate of an existing
51+
issue](https://github.com/Tygo-van-den-Hurk/Slyde/issues?q=label%3A%22test%22).
52+
required: true
53+
- label: >
54+
I assert that this is a bug and not a support request.
55+
required: true
56+
- type: "markdown"
57+
attributes:
58+
value: |
59+
### Thank you for filling out this issue!
60+
61+
---
62+
- type: "textarea"
63+
id: "prioritisation"
64+
attributes:
65+
label: "Is this issue important to you?"
66+
description: |
67+
**Please do not modify this text area!**
68+
This template helps developers know which issues should be prioritised
69+
by allowing users to vote with a :+1: reaction. This is not a guarantee
70+
that highly-requested issues will be fixed first, but it helps us to
71+
figure out what's important to users. Please react on other users'
72+
issues if you find them important.
73+
value: |
74+
Add a :+1: [reaction] to [issues you find important].
75+
76+
[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
77+
[issues you find important]: https://github.com/Tygo-van-den-Hurk/Slyde/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc

0 commit comments

Comments
 (0)
⚡