Skip to content

Commit fbc1f8a

Browse files
authored
Update PR Template (#138)
1 parent f0e0ba7 commit fbc1f8a

File tree

1 file changed

+12
-30
lines changed

1 file changed

+12
-30
lines changed

.github/pull_request_template.md

+12-30
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
1-
<!--
2-
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
3-
or ask in this Pull Request and a Gruntwork core maintainer will be happy to help :)
4-
Note: Remember to add '[WIP]' to the beginning of the title if this PR is still a work-in-progress. Remove it when it is ready for review!
5-
-->
1+
<!-- Prepend '[WIP]' to the title if this PR is still a work-in-progress. Remove it when it is ready for review! -->
62

73
## Description
84

9-
<!-- Write a brief description of the changes introduced by this PR -->
5+
Fixes #000.
106

11-
### Documentation
12-
13-
<!--
14-
If this is a feature PR, then where is it documented?
15-
16-
- If docs exist:
17-
- Update any references, if relevant.
18-
- If no docs exist:
19-
- Create a stub for documentation including bullet points for how to use the feature, code snippets (including from happy path tests), etc.
20-
-->
21-
22-
<!-- Important: Did you make any backward incompatible changes? If yes, then you must write a migration guide! -->
7+
<!-- Description of the changes introduced by this PR. -->
238

249
## TODOs
2510

26-
Please ensure all of these TODOs are completed before asking for a review.
11+
Read the [Gruntwork contribution guidelines](https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e).
2712

28-
- [ ] Ensure the branch is named correctly with the issue number. e.g: `feature/new-vpc-endpoints-955` or `bug/missing-count-param-434`.
2913
- [ ] Update the docs.
30-
- [ ] Keep the changes backward compatible where possible.
31-
- [ ] Run the pre-commit checks successfully.
32-
- [ ] Run the relevant tests successfully.
14+
- [ ] Run the relevant tests successfully, including pre-commit checks.
3315
- [ ] 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.
16+
- [ ] Include release notes. If this PR is backward incompatible, include a migration guide.
17+
18+
## Release Notes (draft)
3419

20+
<!-- One-line description of the PR that can be included in the final release notes. -->
21+
Added / Removed / Updated [X].
3522

36-
## Related Issues
23+
### Migration Guide
3724

38-
<!--
39-
Link to related issues, and issues fixed or partially addressed by this PR.
40-
e.g. Fixes #1234
41-
e.g. Addresses #1234
42-
e.g. Related to #1234
43-
-->
25+
<!-- Important: If you made any backward incompatible changes, then you must write a migration guide! -->

0 commit comments

Comments
 (0)