Skip to content

Commit 5201aaf

Browse files
authored
Merge pull request #189 from commitizen-tools/enhance-github-template
Enhance GitHub template
2 parents d28f6b7 + 4399ba1 commit 5201aaf

File tree

4 files changed

+97
-5
lines changed

4 files changed

+97
-5
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.

.github/pull_request_template.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,35 @@
1-
## Related Issue
1+
(Thanks for sending a pull request! Please fill in the following content to let us know better about this change.)
22

3-
## Detail
3+
## Types of changes
4+
Please put an `x` in the box that applies
45

5-
## Checklist:
6+
- [ ] **Bugfix**
7+
- [ ] **New feature**
8+
- [ ] **Refactoring**
9+
- [ ] **Breaking change** (any change that would cause existing functionality to not work as expected)
10+
- [ ] **Documentation Update**
11+
- [ ] **Other (please describe)**
12+
13+
## Description
14+
**Describe what the change is**
615

7-
- [ ] Run "./script/lint" and "./script/test" locally to ensure this change passes linter check and test
8-
- [ ] Add test cases to all the changes
16+
## Checklist:
17+
- [ ] Add test cases to all the changes you introduce
18+
- [ ] Run `./script/lint` and `./script/test` locally to ensure this change passes linter check and test
919
- [ ] Test the changes on the local machine manually
1020
- [ ] Update the documentation for the changes
21+
22+
## Steps to Test This Pull Request
23+
Steps to reproduce the behavior:
24+
1. ...
25+
2. ...
26+
3. ...
27+
28+
## Expected behavior
29+
A clear and concise description of what you expected to happen
30+
31+
## Related Issue
32+
If applicable, reference to the issue related to this pull request.
33+
34+
## Additional context
35+
Add any other context or screenshots about the pull request here.

0 commit comments

Comments
 (0)