Skip to content

Commit 2654ab3

Browse files
committed
Improved version of feature request template
1 parent 9401bad commit 2654ab3

2 files changed

Lines changed: 15 additions & 9 deletions

File tree

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
1+
Sure, here's an improved version of the feature request template for an open-source project:
2+
13
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels:
4+
name: Feature Request
5+
about: Suggest an idea for enhancing the project
6+
title: '[Feature Request Title]'
7+
labels: [Type: Feature Request]
68
assignees: ''
79

810
---
911

12+
## Summary
13+
A clear and concise description of the feature or enhancement you would like to see implemented. Explain how this solution can resolve the problem stated above. Be specific and provide details about how the new feature should work.
14+
1015
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
A clear and concise description of the problem you have encountered or the need that this feature aims to address. For example: "I'm always frustrated when [...]" or "This project lacks a crucial functionality for [...]."
1217

1318
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
19+
A clear and concise description of the feature or enhancement you would like to see implemented. Explain how this solution can resolve the problem stated above. Be specific and provide details about how the new feature should work.
1520

1621
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
22+
If you have explored any alternative solutions or features to address the problem, please describe them here. This can help us understand your thought process and why you believe your proposed solution is the best one.
1823

1924
**Additional context**
20-
Add any other context or screenshots about the feature request here.
25+
Add any other relevant context, background information, or screenshots that might be helpful in understanding the feature request. This could include use-case scenarios, examples from other projects, or any other pertinent information that could aid in the evaluation of the idea.
26+

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ git checkout -b <your_branch_name>
4949

5050
10. Check your changes
5151
```
52-
git staus
52+
git status
5353
```
5454
```
5555
git diff

0 commit comments

Comments
 (0)