diff --git a/.github/workflows/pull_request_template.md b/.github/workflows/pull_request_template.md new file mode 100644 index 00000000..fcfb1d2e --- /dev/null +++ b/.github/workflows/pull_request_template.md @@ -0,0 +1,18 @@ +**Checklist** + +Please verify the following checklist in order: +- [ ] If releasing module changes, the Pull Request title is prepended with "[\]". E.g., a title may be "[2301] Compute RP changes". Otherwise, this is not necessary. +- [ ] Updated origin `dev` branch locally. (`git fetch origin dev`) +- [ ] The Pull Request has a single commit. The following is a standard way to achieve a single commit: + - `git checkout feature` + - `git rebase origin/dev -i` + - In the VIM editor press `ESC` and `i` to enter edit mode. + - Select commits to fixup or squash commits (instructions are in the editor). + - Press `ESC`, type `:wq`, and press `Enter` to save and quit. +- [ ] Resolved any rebase conflicts (basically merge conflicts). +- [ ] Commits are rebased on top of latest remote `dev` branch. +- [ ] The changes are tested. Make sure to test after the rebase step. +- [ ] Updated remote feature branch. (Force push if you've rebased onto new changes from dev: `git push origin feature -f`) + +**Description** + \ No newline at end of file