Skip to content

Commit e5c0600

Browse files
committed
chore: update issue templates
1 parent 31d1346 commit e5c0600

File tree

2 files changed

+43
-82
lines changed

2 files changed

+43
-82
lines changed

.github/ISSUE_TEMPLATE/bug-report.yaml

Lines changed: 27 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ body:
55
- type: textarea
66
attributes:
77
label: Describe the bug
8-
description: Provide a clear and concise description of what the bug is.
8+
description: Provide a clear and concise description of what the bug is. Include screenshots if applicable.
99
validations:
1010
required: true
1111
- type: textarea
1212
attributes:
1313
label: Steps to reproduce
14-
description: Provide detailed steps to replicate the bug.
14+
description: |
15+
Provide detailed steps to replicate the bug. Make sure to describe the current behavior.
16+
If applicable, include full errors, stack traces, and/or relevant logs.
1517
placeholder: |
1618
1. In this environment...
1719
2. With this config...
@@ -21,65 +23,36 @@ body:
2123
required: true
2224
- type: textarea
2325
attributes:
24-
label: Expected behavior
25-
description: What did you expect to happen?
26-
validations:
27-
required: true
28-
- type: textarea
29-
attributes:
30-
label: Current behavior
26+
label: Acceptance Criteria
3127
description: |
32-
What actually happened?
33-
34-
Include full errors, stack traces, and/or relevant logs.
35-
validations:
36-
required: true
37-
- type: textarea
38-
attributes:
39-
label: Possible reason(s)
40-
description: Provide any insights into what might be causing the issue.
41-
validations:
42-
required: false
43-
- type: textarea
44-
attributes:
45-
label: Suggested fix
46-
description: Provide any suggestions on how to resolve the bug.
47-
validations:
48-
required: false
49-
- type: textarea
50-
attributes:
51-
label: Branch, commit, and/or version
52-
description: Provide the branch, commit, and/or version you're using.
28+
Provide the criteria that must be met in order for this issue to be considered fixed.
29+
Be specific, and consider potential edge cases. The criteria should be observable and testable.
5330
placeholder: |
54-
branch: issue-1
55-
commit: abc123d
31+
Given a user or system is in ... (a page, workflow, or state)
32+
And ... (optional other criteria that needs to be met)
33+
When the user ... (action)
34+
Then ... (expected outcome)
35+
And ... (additional observable outcome)
5636
validations:
5737
required: true
5838
- type: textarea
5939
attributes:
60-
label: Screenshots
61-
description: If applicable, add screenshots with descriptions to help explain your problem.
40+
label: Possible reason(s)/Suggested Fix
41+
description: Provide any insights into what might be causing the issue and/or how to resolve it.
6242
validations:
6343
required: false
6444
- type: textarea
6545
attributes:
66-
label: Environment details
67-
description: Provide environment details (OS name and version, etc).
68-
validations:
69-
required: true
70-
- type: textarea
71-
attributes:
72-
label: Additional details
73-
description: Provide any other additional details about the problem.
74-
validations:
75-
required: false
76-
- type: dropdown
77-
attributes:
78-
label: Contribution
79-
description: Can you contribute to the development of this feature?
80-
options:
81-
- "Yes, I can create a PR for this fix."
82-
- "Yes, but I can only provide ideas and feedback."
83-
- "No, I cannot contribute."
84-
validations:
85-
required: false
46+
label: Environment & Version
47+
description: |
48+
Provide the branch, commit, and/or version you're using, along with environment details
49+
(e.g., OS name and version, browser, runtime, deployment environment).
50+
placeholder: |
51+
branch:
52+
commit:
53+
version:
54+
browser (if applicable - Chrome, Firefox, Safari, etc.):
55+
deployment environment (dev, prod, staging, local):
56+
operating system (Mac, Windows, Linux, other):
57+
validations:
58+
required: true

.github/ISSUE_TEMPLATE/feature-request.yaml

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ body:
55
- type: textarea
66
attributes:
77
label: Feature description
8-
description: Provide a clear and concise description of what you want to happen.
8+
description: |
9+
Provide a clear and concise description of what you want to happen.
10+
Include screenshots, wireframes, mockups, diagrams, or other supporting artifacts if available.
911
validations:
1012
required: true
1113
- type: textarea
@@ -17,20 +19,22 @@ body:
1719
required: true
1820
- type: textarea
1921
attributes:
20-
label: Proposed solution
21-
description: Provide proposed solution.
22-
validations:
23-
required: false
24-
- type: textarea
25-
attributes:
26-
label: Alternatives considered
27-
description: Describe any alternative solutions you've considered.
22+
label: Acceptance Criteria
23+
description: |
24+
Provide the criteria that must be met in order for this issue to be considered complete.
25+
Be specific, and consider potential edge cases. The criteria should be observable and testable.
26+
placeholder: |
27+
Given a user or system is in ... (a page, workflow, or state)
28+
And ... (optional other criteria that needs to be met)
29+
When the user ... (action)
30+
Then ... (expected outcome)
31+
And ... (additional observable outcome)
2832
validations:
29-
required: false
33+
required: true
3034
- type: textarea
3135
attributes:
32-
label: Implementation details
33-
description: Provide any technical details on how the feature might be implemented.
36+
label: Proposed solution
37+
description: Describe a possible solution or any technical considerations, if known.
3438
validations:
3539
required: false
3640
- type: textarea
@@ -42,19 +46,3 @@ body:
4246
What challenges might arise?
4347
validations:
4448
required: false
45-
- type: textarea
46-
attributes:
47-
label: Additional context
48-
description: Provide any other context or screenshots about the feature.
49-
validations:
50-
required: false
51-
- type: dropdown
52-
attributes:
53-
label: Contribution
54-
description: Can you contribute to the development of this feature?
55-
options:
56-
- "Yes, I can create a PR for this feature."
57-
- "Yes, but I can only provide ideas and feedback."
58-
- "No, I cannot contribute."
59-
validations:
60-
required: false

0 commit comments

Comments
 (0)