diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1ed18da..6b100e4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,43 +1,25 @@ - + ## Description - +Fixes #000. -### Documentation - - - - + ## TODOs -Please ensure all of these TODOs are completed before asking for a review. +Read the [Gruntwork contribution guidelines](https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e). -- [ ] Ensure the branch is named correctly with the issue number. e.g: `feature/new-vpc-endpoints-955` or `bug/missing-count-param-434`. - [ ] Update the docs. -- [ ] Keep the changes backward compatible where possible. -- [ ] Run the pre-commit checks successfully. -- [ ] Run the relevant tests successfully. +- [ ] Run the relevant tests successfully, including pre-commit checks. - [ ] Ensure any 3rd party code adheres with our [license policy](https://www.notion.so/gruntwork/Gruntwork-licenses-and-open-source-usage-policy-f7dece1f780341c7b69c1763f22b1378) or delete this line if its not applicable. +- [ ] Include release notes. If this PR is backward incompatible, include a migration guide. + +## Release Notes (draft) + +Added / Removed / Updated [X]. -## Related Issues +### Migration Guide - +