From c0ce2dbd127d6c2f2104e99c8ad14a1a21294548 Mon Sep 17 00:00:00 2001 From: go-to-k <24818752+go-to-k@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:59:52 +0900 Subject: [PATCH] docs: add description for PR title rule in PR template .projenrc.ts --- .github/pull_request_template.md | 3 +++ .projenrc.ts | 5 ++++- CONTRIBUTING.md | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e34d3f3..5547d2d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,6 +17,9 @@ Closes #. ### Checklist - [ ] 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 --- _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license_ diff --git a/.projenrc.ts b/.projenrc.ts index de1c49e..818a5b3 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -52,7 +52,10 @@ Closes #. ### 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 index 7f087a6..cfbf17c 100644 --- 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.