diff --git a/.github/PULL_REQUEST_TEMPLATE/standard.md b/.github/PULL_REQUEST_TEMPLATE/standard.md new file mode 100644 index 000000000..deb785f0f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/standard.md @@ -0,0 +1,30 @@ +# PR Standards + +## Opening a pull request should be able to meet the following requirements: + +--- + +For Author: + +- [ ] Targeted PR against correct branch +- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title +- [ ] Linked to Github issue with discussion and accepted design +- [ ] Targets only one github issue +- [ ] Wrote unit and integration tests +- [ ] All CI checks have passed +- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code) + +--- + +For Reviewer: + +- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title +- [ ] Reviewers assigned +- [ ] confirmed all author checklist items have been addressed + +--- + +After reviewer approval: + +- [ ] In case targets main branch, PR should be squashed and merged. +- [ ] In case PR targets a release branch, PR should be rebased.