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 rule for PR title about module scope #49

Merged
merged 3 commits into from
Sep 15, 2024
Merged

docs: add rule for PR title about module scope #49

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f026418
docs: add rule for PR title about module
go-to-k Sep 14, 2024
42396e8
modify
go-to-k Sep 14, 2024
2462511
Merge branch 'main' into contribution-guide-pr-title
hoegertn Sep 15, 2024
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
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop

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

3 changes: 3 additions & 0 deletions .projenrc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ Closes #<issue number here>.
printWidth: 120,
arrowParens: ArrowParens.AVOID,
},
ignoreFileOptions: {
ignorePatterns: ['*.md'],
},
hoegertn marked this conversation as resolved.
Show resolved Hide resolved
},
});

Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading