Skip to content

Commit 649175a

Browse files
go-to-khoegertn
andauthored
docs: add rule for PR title about module scope (#49)
* docs: add rule for PR title about module * modify --------- Co-authored-by: Thorsten Hoeger <thorsten.hoeger@taimos.de>
1 parent a2958dd commit 649175a

File tree

3 files changed

+7
-0
lines changed

3 files changed

+7
-0
lines changed

.prettierignore

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.projenrc.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ Closes #<issue number here>.
8585
printWidth: 120,
8686
arrowParens: ArrowParens.AVOID,
8787
},
88+
ignoreFileOptions: {
89+
ignorePatterns: ['*.md'],
90+
},
8891
},
8992
});
9093

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,9 @@ When submitting a pull request, please ensure that you have followed the guideli
250250
* 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.
251251
* `feat`: Describe the feature (not the action of creating the commit or PR, for example, avoid words like "added" or "changed")
252252
* `fix`: Describe the bug (not the solution)
253+
* In the case of changes to a specific module, the scope of the title should include the name of that module.
254+
* e.g.) `feat(aws-s3): description of the change`
255+
* Do not omit the `aws-` part.
253256
* Formatting guidelines for titles:
254257
* Title should be lowercase (except for the special use of `Revert`).
255258
* Do not end the title with a period.

0 commit comments

Comments
 (0)