Skip to content

Commit 356fe8e

Browse files
SableRafSableRaf
authored
Simplify issue templates (#1150)
Made a few tweaks to the issue templates to make them easier to use (fewer input fields) and make the call to contribute feel more inclusive.
1 parent 0f23b3e commit 356fe8e

File tree

3 files changed

+82
-72
lines changed

3 files changed

+82
-72
lines changed

‎.github/ISSUE_TEMPLATE/1_bug_report.yml

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@ description: Report broken or incorrect behavior in Processing 4. (For help with
33
labels: [bug]
44
body:
55

6+
67
- type: dropdown
78
id: sub-area
89
attributes:
910
label: Most appropriate sub-area of Processing 4?
1011
description: You may select more than one.
1112
multiple: true
1213
options:
14+
- I'm not sure
1315
- Accessibility
1416
- Core/Environment/Rendering
1517
- PDE
@@ -33,7 +35,7 @@ body:
3335
- type: input
3436
attributes:
3537
label: Processing version
36-
description: Go to "Help > About Processing" and look in the bottom-right corner for the version number. It also appears in the title bar of every editor window.
38+
description: Go to "Help > About Processing" and look in the bottom-right corner for the version number.
3739
validations:
3840
required: true
3941

@@ -44,6 +46,15 @@ body:
4446
validations:
4547
required: true
4648

49+
- type: textarea
50+
attributes:
51+
label: Bug description
52+
description: |
53+
Describe the bug in detail. Include what you expected to happen and what actually happened.
54+
If applicable, include any error messages you received.
55+
validations:
56+
required: true
57+
4758
- type: textarea
4859
attributes:
4960
label: Steps to reproduce this
@@ -80,22 +91,24 @@ body:
8091
- type: textarea
8192
attributes:
8293
label: Additional context
83-
description: Add any other context about the problem here.
94+
description: Provide any other information, links, or screenshots that could help illustrate the bug.
8495
validations:
8596
required: false
8697

8798
- type: dropdown
8899
attributes:
89100
label: Would you like to work on the issue?
90101
description: |
91-
Thank you for reporting this issue! Processing is a community-driven, open-source project. That means issues like this often rely on contributors like you to help investigate and fix them.
92-
93-
Let us know if you’d like to try fixing it yourself, and don’t worry, we can guide you through the process. If not, that’s okay too. Your report is appreciated.
94-
95-
See [CONTRIBUTING.md](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md) to learn more about how to get involved.
102+
If not, that’s okay too. Your report is appreciated.
96103
options:
97104
- No, I’m just reporting the issue
98105
- Yes, I’d like to help with this
99106
- I’m not sure yet
100107
validations:
101-
required: true
108+
required: true
109+
110+
- type: markdown
111+
attributes:
112+
value: |
113+
> [!NOTE]
114+
> Processing is a community-driven, open-source project. If you have time and interest to help, your contribution would be greatly appreciated! See the [contribution guide](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md) to learn more. And if you need some guidance or support, we're happy to help you get started.

‎.github/ISSUE_TEMPLATE/2_enhancement.yml

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ description: Suggest an improvement for an existing feature of Processing.
33
labels: [enhancement]
44
body:
55

6+
- type: markdown
7+
attributes:
8+
value: |
9+
> [!TIP]
10+
> If you have an idea for something Processing doesn’t yet support, **creating a library** is often the best way to contribute. Read more about creating a library [here](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md#adding-new-features-to-processing).
11+
612
- type: dropdown
713
id: feature-area
814
attributes:
915
label: Most relevant area for this enhancement?
1016
description: Choose the most relevant area for the proposed feature or improvement.
1117
multiple: true
1218
options:
19+
- I'm not sure
1320
- Accessibility
1421
- Core/Environment/Rendering
1522
- PDE
@@ -39,44 +46,38 @@ body:
3946

4047
- type: textarea
4148
attributes:
42-
label: Desired enhancement
43-
description: Describe the improvement you’d like to see with that existing feature
49+
label: Enhancement details
50+
description: |
51+
Describe the improvement you’d like to see for this existing feature.
52+
value: |
53+
#### Enhancement description
54+
Describe the enhancement in detail. Include how it should work and its intended impact.
55+
56+
#### Benefits
57+
Outline how this enhancement would benefit users or improve Processing.
58+
59+
#### Challenges
60+
Discuss any possible challenges or considerations in implementing this enhancement.
61+
62+
#### Additional context
63+
Provide any additional context or screenshots that may help clarify the enhancement.
4464
validations:
4565
required: true
4666

47-
- type: textarea
48-
attributes:
49-
label: Potential benefits
50-
description: Explain how this enhancement could benefit users or improve Processing.
51-
validations:
52-
required: false
53-
54-
- type: textarea
55-
attributes:
56-
label: Possible drawbacks
57-
description: Consider any possible drawbacks or challenges related to the implementation of this enhancement.
58-
validations:
59-
required: false
60-
61-
- type: textarea
62-
attributes:
63-
label: Additional context
64-
description: Add any other context or screenshots about the feature request here.
65-
validations:
66-
required: false
67-
6867
- type: dropdown
6968
attributes:
70-
label: Would you like to work on the issue?
69+
label: Would you like to help implement this enhancement?
7170
description: |
72-
Thank you for reporting this issue! Processing is a community-driven, open-source project. That means issues like this often rely on contributors like you to help investigate and fix them.
73-
74-
Let us know if you’d like to try fixing it yourself, and don’t worry, we can guide you through the process. If not, that’s okay too. Your report is appreciated.
75-
76-
See [CONTRIBUTING.md](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md) to learn more about how to get involved.
71+
If not, that’s okay too. Your suggestion is appreciated.
7772
options:
78-
- No, I’m just reporting the issue
73+
- No, I’m just suggesting the enhancement
7974
- Yes, I’d like to help with this
8075
- I’m not sure yet
8176
validations:
82-
required: true
77+
required: true
78+
79+
- type: markdown
80+
attributes:
81+
value: |
82+
> [!NOTE]
83+
> Processing is a community-driven, open-source project. If you have time and interest to help, your contribution would be greatly appreciated! See the [contribution guide](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md) to learn more. And if you need some guidance or support, we're happy to help you get started.

‎.github/ISSUE_TEMPLATE/3_feature-request.yml

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ description: Request adding a new feature to Processing
33
labels: [new feature]
44
body:
55

6+
- type: markdown
7+
attributes:
8+
value: |
9+
> [!TIP]
10+
> If you have an idea for something Processing doesn’t yet support, **creating a library** is often the best way to contribute. Read more about creating a library [here](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md#adding-new-features-to-processing).
11+
612
- type: dropdown
713
id: feature-area
814
attributes:
915
label: Relevant sub-area for this feature?
1016
description: Choose the sub-area most relevant to your feature request.
1117
multiple: true
1218
options:
19+
- I'm not sure
1320
- Accessibility
1421
- Core/Environment/Rendering
1522
- PDE
@@ -31,49 +38,38 @@ body:
3138
required: true
3239

3340
- type: textarea
34-
id: feature-description
41+
id: feature-details
3542
attributes:
36-
label: Feature description
37-
description: Describe the feature in detail. Include how it should work and its intended impact.
38-
validations:
39-
required: true
43+
label: Feature details
44+
description: |
45+
#### Feature description
46+
Describe the feature in detail. Include how it should work and its intended impact.
4047
41-
- type: textarea
42-
id: benefits
43-
attributes:
44-
label: Benefits
45-
description: Outline how this feature would benefit users or improve Processing.
46-
validations:
47-
required: true
48+
#### Benefits
49+
Outline how this feature would benefit users or improve Processing.
4850
49-
- type: textarea
50-
id: challenges
51-
attributes:
52-
label: Possible challenges
53-
description: Discuss any possible challenges or considerations in implementing this feature.
54-
validations:
55-
required: false
51+
#### Challenges
52+
Discuss any possible challenges or considerations in implementing this feature.
5653
57-
- type: textarea
58-
id: additional-context
59-
attributes:
60-
label: Additional context
61-
description: Provide any other information, links, or screenshots that could help illustrate the feature.
54+
#### Additional context
55+
Provide any other information, links, or screenshots that could help illustrate the feature.
6256
validations:
63-
required: false
57+
required: true
6458

6559
- type: dropdown
6660
attributes:
67-
label: Would you like to work on the issue?
61+
label: Would you like to help implement this feature?
6862
description: |
69-
Thank you for reporting this issue! Processing is a community-driven, open-source project. That means issues like this often rely on contributors like you to help investigate and fix them.
70-
71-
Let us know if you’d like to try fixing it yourself, and don’t worry, we can guide you through the process. If not, that’s okay too. Your report is appreciated.
72-
73-
See [CONTRIBUTING.md](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md) to learn more about how to get involved.
63+
If not, that’s okay too. Your suggestion is appreciated.
7464
options:
75-
- No, I’m just reporting the issue
65+
- No, I’m just suggesting the feature
7666
- Yes, I’d like to help with this
7767
- I’m not sure yet
7868
validations:
79-
required: true
69+
required: true
70+
71+
- type: markdown
72+
attributes:
73+
value: |
74+
> [!NOTE]
75+
> Processing is a community-driven, open-source project. If you have time and interest to help, your contribution would be greatly appreciated! See the [contribution guide](https://github.com/processing/processing4/blob/main/CONTRIBUTING.md) to learn more. And if you need some guidance or support, we're happy to help you get started.

0 commit comments

Comments
 (0)