docs: add description for PR title rule in PR template

.projenrc.ts
open-constructs · Jan 15, 2025 · c0ce2db · c0ce2db
1 parent 462e2c0
commit c0ce2db
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -52,7 +52,10 @@ Closes #<issue number here>.
 
 ### Checklist
 
-- [ ] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/open-constructs/aws-cdk-library/blob/main/CONTRIBUTING.md)`,
+- [ ] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/open-constructs/aws-cdk-library/blob/main/CONTRIBUTING.md)
+- [ ] My pull request adheres to the [Pull Request Rule](https://github.com/open-constructs/aws-cdk-library/blob/main/CONTRIBUTING.md#pull-request)
+  - **Do not omit the \`aws-\` part in the scope of the PR title if the PR relates to a specific AWS service module.**
+  - e.g.) feat(**aws-s3**): description of the change`,
   ],
   releaseTrigger: release.ReleaseTrigger.continuous(),
   releasableCommits: ReleasableCommits.ofType(['feat', 'fix', 'revert', 'Revert']),

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -252,7 +252,7 @@ When submitting a pull request, please ensure that you have followed the guideli
   * `fix`: Describe the bug (not the solution)
 * In the case of changes to a specific module, the scope of the title should include the name of that module.
   * e.g.) `feat(aws-s3): description of the change`
-  * Do not omit the `aws-` part.
+  * Do not omit the `aws-` part in the scope of the PR title if the PR relates to a specific AWS service module.
 * Formatting guidelines for titles:
   * Title should be lowercase (except for the special use of `Revert`).
   * Do not end the title with a period.