Skip to content

Commit 056c766

Browse files
woileLee-W
authored andcommitted
docs: polish github templates
- information for submitter are now comments - removed redundancy in titles, we use labels now - typos corrections
1 parent 4982f1d commit 056c766

File tree

4 files changed

+52
-33
lines changed

4 files changed

+52
-33
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+20-12
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,38 @@
11
---
22
name: 🛠 Bug report
33
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."
4+
title: "Good bug title tells us about precise symptom, not about the root cause."
55
labels: "bug"
66
assignees: ""
77
---
88

99
## Description
10-
A clear and concise description of what the bug is.
10+
<!-- A clear and concise description of what the bug is. -->
1111

12-
## commitizen version
13-
x.y.z
14-
15-
## Steps to Reproduce
16-
Steps to reproduce the behavior:
12+
## Steps to reproduce
13+
<!-- Steps to reproduce the behavior:
1714
1. Run ...
1815
2. ...
19-
3. ...
16+
3. ... -->
17+
18+
## Current behavior
19+
<!-- What happens actually so you think this is a bug. -->
2020

21-
## Expected Behavior
21+
## Desired behavior
22+
<!--
2223
A clear and concise description of what you expected to happen.
2324
2425
**Screenshots**
2526
If applicable, add screenshots to help explain your problem.
27+
-->
2628

27-
## Actual Behavior
28-
What happens actually so you think this is a bug.
29+
## Environment
30+
<!--
31+
cz version
32+
python --version
33+
python3 -c "import platform; print(platform.system())"
34+
-->
2935

30-
## More Information
36+
- commitizen version:
37+
- python version:
38+
- operating system:
+5-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
22
name: 📖 Documentation
33
about: Suggest an improvement for the documentation of this project
4-
title: "[Documentation] Content to be added or fixed"
4+
title: "Content to be added or fixed"
55
labels: "documentation"
66
assignees: ""
77
---
88

99
## Type
10-
* [ ] Conent inaccurate
10+
11+
* [ ] Content inaccurate
1112
* [ ] Content missing
1213
* [ ] Typo
1314

1415
## URL
15-
URL to the code we did not clearly describe or the document page where the content is inaccurate
16+
<!-- URL to the code we did not clearly describe or the document page where the content is inaccurate -->
1617

1718
## Description
18-
A clear and concise description of what content should be added or fixed
19+
<!-- A clear and concise description of what content should be added or fixed -->
+6-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
name: 🚀 Feature request
33
about: Suggest an idea for this project
4-
title: "[Feature Request] <One feature request per issue>"
5-
labels: ""
4+
title: "<One feature request per issue>"
5+
labels: "enhancement"
66
assignees: ""
77
---
88

99
## Description
10-
A clear and concise description for us to know your idea.
10+
<!-- A clear and concise description for us to know your idea. -->
1111

1212
## Possible Solution
13-
A clear and concise description of what you want to happen.
13+
<!-- A clear and concise description of what you want to happen. -->
1414

1515
## Additional context
16-
Add any other context or screenshots about the feature request here.
16+
<!-- Add any other context or screenshots about the feature request here. -->
1717

1818
## Related Issue
19-
If applicable, add link to existing issue also help us know better.
19+
<!-- If applicable, add link to existing issue also help us know better. -->

.github/pull_request_template.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,45 @@
1-
(Thanks for sending a pull request! Please fill in the following content to let us know better about this change.)
1+
<!--
2+
Thanks for sending a pull request!
3+
Please fill in the following content to let us know better about this change.
4+
-->
25

36
## Types of changes
4-
Please put an `x` in the box that applies
57

6-
- [ ] **Bugfix**
8+
<!-- Please put an `x` in the box that applies -->
9+
10+
- [ ] **Bug fix**
711
- [ ] **New feature**
812
- [ ] **Refactoring**
913
- [ ] **Breaking change** (any change that would cause existing functionality to not work as expected)
10-
- [ ] **Documentation Update**
14+
- [ ] **Documentation update**
1115
- [ ] **Other (please describe)**
1216

1317
## Description
14-
**Describe what the change is**
1518

16-
## Checklist:
19+
<!-- Describe what the change is -->
20+
21+
## Checklist
22+
1723
- [ ] Add test cases to all the changes you introduce
1824
- [ ] Run `./script/format` and `./script/test` locally to ensure this change passes linter check and test
1925
- [ ] Test the changes on the local machine manually
2026
- [ ] Update the documentation for the changes
2127

2228
## Steps to Test This Pull Request
23-
Steps to reproduce the behavior:
29+
30+
<!-- Steps to reproduce the behavior:
2431
1. ...
2532
2. ...
26-
3. ...
33+
3. ... -->
2734

2835
## Expected behavior
29-
A clear and concise description of what you expected to happen
36+
37+
<!-- A clear and concise description of what you expected to happen -->
3038

3139
## Related Issue
32-
If applicable, reference to the issue related to this pull request.
40+
41+
<!-- If applicable, reference to the issue related to this pull request. -->
3342

3443
## Additional context
35-
Add any other context or screenshots about the pull request here.
44+
45+
<!-- Add any other context or screenshots about the pull request here. -->

0 commit comments

Comments
 (0)