Skip to content

Commit

Permalink
docs: update PR template (#472)
Browse files Browse the repository at this point in the history
  • Loading branch information
VictorTrustyDev authored and omritoptix committed Jan 9, 2024
1 parent d548bc8 commit 86fc8a1
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# PR Standards
## Description

## Opening a pull request should be able to meet the following requirements:
<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review.
-->

---
----

Closes #XXX

**All** items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow-up issues.

For Author:
PR review checkboxes:

I have...

- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [ ] Targeted PR against the 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 the GitHub issue with discussion and accepted design
Expand All @@ -19,13 +29,13 @@ For Author:

For Reviewer:

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] 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
- [ ] Confirmed all author checklist items have been addressed

---;
---

After reviewer approval:

- [ ] In case it targets the main branch, PR should be squashed and merged.
- [ ] In case the PR targets a release branch, PR should be rebased.
- [ ] In case the PR targets the main branch, PR should not be squash merge in order to keep meaningful git history.
- [ ] In case the PR targets a release branch, PR must be rebased.

0 comments on commit 86fc8a1

Please sign in to comment.