-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: create a pr standard template (#293)
- Loading branch information
1 parent
162b3e6
commit 8d7cb10
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |