diff --git a/.prettierignore b/.prettierignore index 3385eb8..1ba484b 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,2 @@ # ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". +*.md diff --git a/.projenrc.ts b/.projenrc.ts index d03bb1a..de1c49e 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -85,6 +85,9 @@ Closes #. printWidth: 120, arrowParens: ArrowParens.AVOID, }, + ignoreFileOptions: { + ignorePatterns: ['*.md'], + }, }, }); diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b17a5d4..173db20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -238,6 +238,9 @@ When submitting a pull request, please ensure that you have followed the guideli * Titles for `feat` and `fix` PRs end up in the change log. Think about what makes most sense for users reading the changelog while writing them. * `feat`: Describe the feature (not the action of creating the commit or PR, for example, avoid words like "added" or "changed") * `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. * Formatting guidelines for titles: * Title should be lowercase (except for the special use of `Revert`). * Do not end the title with a period.