Skip to content

Commit

Permalink
Clarify PR naming conventions in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
This aligns with the feedback I received from `aws-cdk-automation` when creating a PR:
>  The title of the pull request should omit 'aws-' from the name of modified packages. Use 'ecs' instead of 'aws-ecs'.
  • Loading branch information
MarrickLip authored Oct 12, 2024
1 parent cd324d0 commit ad0ddff
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -661,6 +661,7 @@ CDK integration tests.
* `fix`: describe the bug (not the solution)
* Title should be lowercase.
* No period at the end of the title.
* The module name should omit `aws-` where relevant e.g. use `feat(ecs)` instead of `feat(aws-ecs)`.

* Pull request body should describe _motivation_. Think about your code reviewers and what information they need in
order to understand what you did. If it's a big commit (hopefully not), try to provide some good entry points so
Expand Down

0 comments on commit ad0ddff

Please sign in to comment.