Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add description for PR title rule in PR template #63

Merged
merged 1 commit into from
Jan 15, 2025
Merged

docs: add description for PR title rule in PR template #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion .projenrc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']),
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading