Skip to content

Commit 3304ced

Browse files
authored
Merge pull request #952 from humanmade/update-standard-issue-templates
Update Standard Issue templates
2 parents 4e94cc5 + 114916f commit 3304ced

File tree

3 files changed

+19
-87
lines changed

3 files changed

+19
-87
lines changed

.github/ISSUE_TEMPLATE/1-bug-report.yml

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -18,47 +18,20 @@ body:
1818
1919
Thank you for helping us fix our product.
2020
21-
- type: input
22-
id: version
23-
attributes:
24-
label: Version
25-
description: What version are you using?
26-
placeholder: Version number
27-
validations:
28-
required: true
29-
30-
- type: textarea
31-
id: expected
32-
attributes:
33-
label: Expected Behaviour
34-
description: A precise description of what you expected to happen
35-
placeholder: What should have happened?
36-
validations:
37-
required: true
38-
39-
- type: textarea
40-
id: actual
41-
attributes:
42-
label: Actual Behaviour
43-
description: A precise description of what actually happened
44-
placeholder: What actually happened?
45-
validations:
46-
required: true
47-
4821
- type: textarea
4922
id: bug-description
5023
attributes:
5124
label: Bug Description
52-
description: A precise description of what the bug is
25+
description: A short description of what the bug is
5326
placeholder: Describe the bug.
5427
validations:
5528
required: true
5629

5730
- type: textarea
58-
id: reproduction
31+
id: steps_to_reproduce
5932
attributes:
60-
label: Steps to Reproduce
61-
description: Precise steps to reproduce the behaviour
33+
label: Steps to Reproduce and Code Sample
34+
description: Precise steps to reproduce the behaviour. You can also add minimal code sample that reproduces the issue.
6235
placeholder: |
6336
Step 1
6437
Step 2
@@ -67,28 +40,19 @@ body:
6740
required: true
6841

6942
- type: textarea
70-
id: code_sample
71-
attributes:
72-
label: Code Sample
73-
description: If you believe it would help, please add a minimal code sample that reproduces the issue
74-
placeholder: Your code goes here
75-
validations:
76-
required: false
77-
78-
- type: textarea
79-
id: logs
43+
id: expected_behaviour
8044
attributes:
81-
label: Error Logs
82-
description: If you believe it would help, please add any error messages or logs
83-
placeholder: Error messages go here.
45+
label: Expected Behaviour
46+
description: Description of what you expected to happen.
47+
placeholder: What should have happened?
8448
validations:
85-
required: false
49+
required: true
8650

8751
- type: textarea
8852
id: additional_info
8953
attributes:
9054
label: Additional Info
9155
description: Add any other info about the problem here (screenshots, videos, related issues, etc.)
92-
placeholder: Additional information that might help.
56+
placeholder: Additional information that might help. Error messages, logs, screenshots, your device, OS version, browser version, etc.
9357
validations:
9458
required: false

.github/ISSUE_TEMPLATE/2-documentation.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ body:
4949
id: description
5050
attributes:
5151
label: Issue Description
52-
description: Describe the documentation issue in detail
52+
description: Describe the documentation issue in detail.
5353
placeholder: "Documentation issue explanation goes here"
5454
validations:
5555
required: true
@@ -58,7 +58,7 @@ body:
5858
id: current-content
5959
attributes:
6060
label: Current Content
61-
description: If you believe it would help, please copy the current documentation content that needs to be fixed
61+
description: If you believe it would help, please copy the current documentation content that needs to be fixed.
6262
render: markdown
6363
placeholder: "Current documentation content."
6464

@@ -74,7 +74,7 @@ body:
7474
id: additional_info
7575
attributes:
7676
label: Additional Info
77-
description: Add any other info that would help us improve the documentation
77+
description: Add any other info that would help us improve the documentation.
7878
placeholder: |
7979
- This confused me because...
8080
- Screenshots would have been helpful because...

.github/ISSUE_TEMPLATE/3-feature.yml

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,11 @@ body:
1818
1919
Thank you for helping us build a better product.
2020
21-
- type: textarea
22-
id: context
23-
attributes:
24-
label: Context
25-
description: Is this request related to a specific problem, workflow, or limitation?
26-
placeholder: Describe the background or scenario that led to this request.
27-
validations:
28-
required: true
29-
3021
- type: textarea
3122
id: current_behaviour
3223
attributes:
33-
label: Current Behaviour
34-
description: A precise description of how things work now
24+
label: Current Behaviour and Context
25+
description: Describe the scenario that led to this request.
3526
placeholder: How is it working now?
3627
validations:
3728
required: true
@@ -40,39 +31,16 @@ body:
4031
id: improved_behaviour
4132
attributes:
4233
label: Improved Behaviour
43-
description: A precise description of how things should work
34+
description: Description of how things should work.
4435
placeholder: How it should be working?
4536
validations:
4637
required: true
4738

4839
- type: textarea
49-
id: impact
40+
id: additional_info
5041
attributes:
51-
label: Impact
52-
description: An explanation why you believe this brings value and what's the impact on other users
53-
placeholder: |
54-
What's the value?
55-
What's the impact?
56-
validations:
57-
required: true
58-
59-
- type: textarea
60-
id: possible_solutions
61-
attributes:
62-
label: Possible Solutions
63-
description: Do you already have ideas or examples of how this could be implemented?
42+
label: Additional Info
43+
description: Any additional info, including ideas or examples of how this could be implemented.
6444
placeholder: Share your thoughts, examples, or references.
6545
validations:
6646
required: false
67-
68-
- type: textarea
69-
id: acceptance_criteria
70-
attributes:
71-
label: Acceptance Criteria
72-
description: When would you say this feature is complete? List clear conditions or test cases.
73-
placeholder: |
74-
- [ ] User can do X
75-
- [ ] Feature works under Y condition
76-
- [ ] Documentation updated
77-
validations:
78-
required: false

0 commit comments

Comments
 (0)