Skip to content

Conversation

@ianbotsf
Copy link
Contributor

Issue #

(none)

Description of changes

Update and clarify the contributing guidelines to more explicitly detail:

  • Expected format for changelog entries
  • Expected format for commit messages

Similar to smithy-lang/smithy-kotlin#706 except also add new commit guidelines.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@ianbotsf ianbotsf requested a review from a team as a code owner September 23, 2022 20:34
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@github-actions
Copy link

A new generated diff is ready to view: __generated-main...__generated-chore-contributing-clarifications

Copy link
Member

@lauzadis lauzadis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I had one question about scopes in the commit message subject


The scope is optional but should be included when possible and refer to a module that is being touched. Examples:

- codegen
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these scopes relevant for the aws-sdk-kotlin repository?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes they are since this project has both runtime and codegen components, same as smithy-kotlin.

That said, the same scopes are not applicable to the parallel PR in aws-crt-kotlin which effectively contains only runtime components...will revise.

@ianbotsf ianbotsf merged commit c715d89 into main Sep 23, 2022
@ianbotsf ianbotsf deleted the chore-contributing-clarifications branch September 23, 2022 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants