Skip to content

Commit d96cae2

Browse files
committed
docs(github): add issue_template for feature_request, bug_report and documentation
1 parent d28f6b7 commit d96cae2

File tree

3 files changed

+67
-0
lines changed

3 files changed

+67
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 🛠 Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug Report] Good bug title tells us about precise symptom, not about the root cause."
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
## Description
10+
A clear and concise description of what the bug is.
11+
12+
## commitizen version
13+
x.y.z
14+
15+
## Steps to Reproduce
16+
Steps to reproduce the behavior:
17+
1. Run ...
18+
2. ...
19+
3. ...
20+
21+
## Expected Behavior
22+
A clear and concise description of what you expected to happen.
23+
24+
**Screenshots**
25+
If applicable, add screenshots to help explain your problem.
26+
27+
## Actual Behavior
28+
What happens actually so you think this is a bug.
29+
30+
## More Information
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 📖 Documentation
3+
about: Suggest an improvement for the documentation of this project
4+
title: "[Documentation] Content to be added or fixed"
5+
labels: "documentation"
6+
assignees: ""
7+
---
8+
9+
## Type
10+
* [ ] Conent inaccurate
11+
* [ ] Content missing
12+
* [ ] Typo
13+
14+
## URL
15+
URL to the code we did not clearly describe or the document page where the content is inaccurate
16+
17+
## Description
18+
A clear and concise description of what content should be added or fixed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: 🚀 Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feature Request] <One feature request per issue>"
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
## Description
10+
A clear and concise description for us to know your idea.
11+
12+
## Possible Solution
13+
A clear and concise description of what you want to happen.
14+
15+
## Additional context
16+
Add any other context or screenshots about the feature request here.
17+
18+
## Related Issue
19+
If applicable, add link to existing issue also help us know better.

0 commit comments

Comments
 (0)