Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: 🛠 Bug report
about: Create a report to help us improve
title: "[Bug Report] Good bug title tells us about precise symptom, not about the root cause."
labels: "bug"
assignees: ""
---

## Description
A clear and concise description of what the bug is.

## commitizen version
x.y.z

## Steps to Reproduce
Steps to reproduce the behavior:
1. Run ...
2. ...
3. ...

## Expected Behavior
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

## Actual Behavior
What happens actually so you think this is a bug.

## More Information
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: 📖 Documentation
about: Suggest an improvement for the documentation of this project
title: "[Documentation] Content to be added or fixed"
labels: "documentation"
assignees: ""
---

## Type
* [ ] Conent inaccurate
* [ ] Content missing
* [ ] Typo

## URL
URL to the code we did not clearly describe or the document page where the content is inaccurate

## Description
A clear and concise description of what content should be added or fixed
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 🚀 Feature request
about: Suggest an idea for this project
title: "[Feature Request] <One feature request per issue>"
labels: ""
assignees: ""
---

## Description
A clear and concise description for us to know your idea.

## Possible Solution
A clear and concise description of what you want to happen.

## Additional context
Add any other context or screenshots about the feature request here.

## Related Issue
If applicable, add link to existing issue also help us know better.
35 changes: 30 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
## Related Issue
(Thanks for sending a pull request! Please fill in the following content to let us know better about this change.)

## Detail
## Types of changes
Please put an `x` in the box that applies

## Checklist:
- [ ] **Bugfix**
- [ ] **New feature**
- [ ] **Refactoring**
- [ ] **Breaking change** (any change that would cause existing functionality to not work as expected)
- [ ] **Documentation Update**
- [ ] **Other (please describe)**

## Description
**Describe what the change is**

- [ ] Run "./script/lint" and "./script/test" locally to ensure this change passes linter check and test
- [ ] Add test cases to all the changes
## Checklist:
- [ ] Add test cases to all the changes you introduce
- [ ] Run `./script/lint` and `./script/test` locally to ensure this change passes linter check and test
- [ ] Test the changes on the local machine manually
- [ ] Update the documentation for the changes

## Steps to Test This Pull Request
Steps to reproduce the behavior:
1. ...
2. ...
3. ...

## Expected behavior
A clear and concise description of what you expected to happen

## Related Issue
If applicable, reference to the issue related to this pull request.

## Additional context
Add any other context or screenshots about the pull request here.