Skip to content

Commit 504e0f8

Browse files
committed
chore: revise issue templates
1 parent a7904d3 commit 504e0f8

File tree

2 files changed

+18
-71
lines changed

2 files changed

+18
-71
lines changed

.github/ISSUE_TEMPLATE/bug-report.yaml

Lines changed: 10 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ body:
1111
- type: textarea
1212
attributes:
1313
label: Steps to reproduce
14-
description: Provide detailed steps to replicate the bug.
14+
description: Provide detailed steps to replicate the bug. Make sure to describe the current behavior. If applicable, include full errors, stack traces, and/or relevant logs.
1515
placeholder: |
1616
1. In this environment...
1717
2. With this config...
@@ -25,33 +25,24 @@ body:
2525
description: What did you expect to happen?
2626
validations:
2727
required: true
28-
- type: textarea
29-
attributes:
30-
label: Current behavior
31-
description: |
32-
What actually happened?
33-
34-
Include full errors, stack traces, and/or relevant logs.
35-
validations:
36-
required: true
3728
- type: textarea
3829
attributes:
3930
label: Acceptance Criteria
4031
description: |
4132
Provide the criteria that must be met in order for this issue to be considered fixed.
42-
Be specific, and consider potential edge cases.
33+
Be specific, and consider potential edge cases. The criteria should be observable and testable.
34+
placeholder: |
35+
Given a user or system is in ... (a page, workflow, or state)
36+
And ... (optional other criteria that needs to be met)
37+
When the user ... (action)
38+
Then ... (expected outcome)
39+
And ... (additional observable outcome)
4340
validations:
4441
required: true
4542
- type: textarea
4643
attributes:
47-
label: Possible reason(s)
48-
description: Provide any insights into what might be causing the issue.
49-
validations:
50-
required: false
51-
- type: textarea
52-
attributes:
53-
label: Suggested fix
54-
description: Provide any suggestions on how to resolve the bug.
44+
label: Possible reason(s)/Suggested Fix
45+
description: Provide any insights into what might be causing the issue or how to resolve it.
5546
validations:
5647
required: false
5748
- type: textarea
@@ -63,31 +54,9 @@ body:
6354
commit: abc123d
6455
validations:
6556
required: true
66-
- type: textarea
67-
attributes:
68-
label: Screenshots
69-
description: If applicable, add screenshots with descriptions to help explain your problem.
70-
validations:
71-
required: false
7257
- type: textarea
7358
attributes:
7459
label: Environment details
7560
description: Provide environment details (OS name and version, etc).
7661
validations:
7762
required: true
78-
- type: textarea
79-
attributes:
80-
label: Additional details
81-
description: Provide any other additional details about the problem.
82-
validations:
83-
required: false
84-
- type: dropdown
85-
attributes:
86-
label: Contribution
87-
description: Can you contribute to the development of this feature?
88-
options:
89-
- "Yes, I can create a PR for this fix."
90-
- "Yes, but I can only provide ideas and feedback."
91-
- "No, I cannot contribute."
92-
validations:
93-
required: false

.github/ISSUE_TEMPLATE/feature-request.yaml

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,19 @@ body:
2020
label: Acceptance Criteria
2121
description: |
2222
Provide the criteria that must be met in order for this issue to be considered complete.
23-
Be specific, and consider potential edge cases.
23+
Be specific, and consider potential edge cases. The criteria should be observable and testable.
24+
placeholder: |
25+
Given a user or system is in ... (a page, workflow, or state)
26+
And ... (optional other criteria that needs to be met)
27+
When the user ... (action)
28+
Then ... (expected outcome)
29+
And ... (additional observable outcome)
2430
validations:
2531
required: true
2632
- type: textarea
2733
attributes:
2834
label: Proposed solution
29-
description: Provide proposed solution.
30-
validations:
31-
required: false
32-
- type: textarea
33-
attributes:
34-
label: Alternatives considered
35-
description: Describe any alternative solutions you've considered.
36-
validations:
37-
required: false
38-
- type: textarea
39-
attributes:
40-
label: Implementation details
41-
description: Provide any technical details on how the feature might be implemented.
35+
description: Provide proposed solution and any technical details on how the feature might be implemented.
4236
validations:
4337
required: false
4438
- type: textarea
@@ -50,19 +44,3 @@ body:
5044
What challenges might arise?
5145
validations:
5246
required: false
53-
- type: textarea
54-
attributes:
55-
label: Additional context
56-
description: Provide any other context or screenshots about the feature.
57-
validations:
58-
required: false
59-
- type: dropdown
60-
attributes:
61-
label: Contribution
62-
description: Can you contribute to the development of this feature?
63-
options:
64-
- "Yes, I can create a PR for this feature."
65-
- "Yes, but I can only provide ideas and feedback."
66-
- "No, I cannot contribute."
67-
validations:
68-
required: false

0 commit comments

Comments
 (0)