Skip to content

Commit 8a94042

Browse files
authored
Enhance feature request template with detailed descriptions
chore: update issue templates
1 parent 3727a3a commit 8a94042

1 file changed

Lines changed: 11 additions & 31 deletions

File tree

.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)