diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..2281f35e7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000000..d1543dc40f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..b43e366394 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: 🚀 Feature request +about: Suggest an idea for this project +title: "[Feature Request] " +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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ceff272b01..82d423a897 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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.