Skip to content

Commit 97bd305

Browse files
committed
chore: update issue templates
1 parent fba497e commit 97bd305

File tree

2 files changed

+36
-91
lines changed

2 files changed

+36
-91
lines changed

.github/ISSUE_TEMPLATE/bug-report.yaml

Lines changed: 25 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5,89 +5,54 @@ 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...
1820
3. Run '...'
1921
4. See error...
2022
validations:
2123
required: true
22-
- type: textarea
23-
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
31-
description: |
32-
What actually happened?
33-
34-
Include full errors, stack traces, and/or relevant logs.
35-
validations:
36-
required: true
3724
- type: textarea
3825
attributes:
3926
label: Acceptance Criteria
4027
description: |
4128
Provide the criteria that must be met in order for this issue to be considered fixed.
42-
Be specific, and consider potential edge cases.
43-
validations:
44-
required: true
45-
- type: textarea
46-
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.
55-
validations:
56-
required: false
57-
- type: textarea
58-
attributes:
59-
label: Branch, commit, and/or version
60-
description: Provide the branch, commit, and/or version you're using.
29+
Be specific, and consider potential edge cases. The criteria should be observable and testable.
6130
placeholder: |
62-
branch: issue-1
63-
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)
6436
validations:
6537
required: true
6638
- type: textarea
6739
attributes:
68-
label: Screenshots
69-
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.
7042
validations:
7143
required: false
7244
- type: textarea
7345
attributes:
74-
label: Environment details
75-
description: Provide environment details (OS name and version, etc).
76-
validations:
77-
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
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: 11 additions & 31 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
@@ -20,25 +22,19 @@ body:
2022
label: Acceptance Criteria
2123
description: |
2224
Provide the criteria that must be met in order for this issue to be considered complete.
23-
Be specific, and consider potential edge cases.
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)
2432
validations:
2533
required: true
2634
- type: textarea
2735
attributes:
2836
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.
37+
description: Describe a possible solution or any technical considerations, if known.
4238
validations:
4339
required: false
4440
- type: textarea
@@ -50,19 +46,3 @@ body:
5046
What challenges might arise?
5147
validations:
5248
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)