Skip to content

Commit

Permalink
docs: create a pr standard template (#293)
Browse files Browse the repository at this point in the history
  • Loading branch information
omritoptix authored Mar 22, 2023
1 parent 162b3e6 commit 8d7cb10
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/standard.md
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.

0 comments on commit 8d7cb10

Please sign in to comment.