Skip to content

Commit 6c945da

Browse files
authored
update the script for pr issue templates (#60)
1 parent 75bd612 commit 6c945da

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

scripts/add-or-update-pr-issue-templates.sh

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ cat << "EOF" > .github/pull_request_template.md
7878
<!--
7979
Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
8080
or ask in this Pull Request and a Gruntwork core maintainer will be happy to help :)
81-
Note: Remember to add '[WIP]' to the beginning of the title if this PR is still a work-in-progress.
81+
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!
8282
-->
8383
8484
## Description
@@ -96,31 +96,26 @@ Note: Remember to add '[WIP]' to the beginning of the title if this PR is still
9696
- Create a stub for documentation including bullet points for how to use the feature, code snippets (including from happy path tests), etc.
9797
-->
9898
99-
<!-- Important: Did you make any backwards incompatible changes? If yes, then you must write a migration guide! -->
99+
<!-- Important: Did you make any backward incompatible changes? If yes, then you must write a migration guide! -->
100100
101101
## TODOs
102102
103+
Please ensure all of these TODOs are completed before asking for a review.
104+
103105
- [ ] Ensure the branch is named correctly with the issue number. e.g: `feature/new-vpc-endpoints-955` or `bug/missing-count-param-434`.
104106
- [ ] Update the docs.
105-
- [ ] Keep the changes backwards compatible where possible.
107+
- [ ] Keep the changes backward compatible where possible.
106108
- [ ] Run the pre-commit checks successfully.
107109
- [ ] Run the relevant tests successfully.
108-
- [ ] Ensure any 3rd party code adheres with our license policy: https://www.notion.so/gruntwork/Gruntwork-licenses-and-open-source-usage-policy-f7dece1f780341c7b69c1763f22b1378
109-
- [ ] _Maintainers Only._ If necessary, release a new version of this repo.
110-
- [ ] _Maintainers Only._ If there were backwards incompatible changes, include a migration guide in the release notes.
111-
- [ ] _Maintainers Only._ Add to the next version of the monthly newsletter (see https://www.notion.so/gruntwork/Monthly-Newsletter-9198cbe7f8914d4abce23dca7b435f43).
110+
- [ ] 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.
112111
113112
114113
## Related Issues
115114
116115
<!--
117-
Link to the issue that is fixed by this PR (if there is one)
116+
Link to related issues, and issues fixed or partially addressed by this PR.
118117
e.g. Fixes #1234
119-
120-
Link to an issue that is partially addressed by this PR (if there are any)
121118
e.g. Addresses #1234
122-
123-
Link to related issues (if there are any)
124119
e.g. Related to #1234
125120
-->
126121
EOF

0 commit comments

Comments
 (0)