Skip to content

Commit bf14c9d

Browse files
committed
docs: list recommended Conventional Commit scopes
1 parent 4cd4cab commit bf14c9d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,23 @@ These apply to any work at Liferay, including in this monorepo:
2121
- [Creating a project](CONTRIBUTING/creating-a-project.md)
2222
- [Importing a project](CONTRIBUTING/importing-a-project.md)
2323
- [Migrating an npm package to the `@liferay` named scope](CONTRIBUTING/migrating-an-npm-package-to-the-liferay-named-scope.md)
24+
25+
## Conventional commit scopes
26+
27+
It is helpful to include [an optional scope in your commit messages](guidelines/general/commit_messages.md) so that people can see, at a glance, which commits affect which projects. Valid scopes correspond to project names such as:
28+
29+
- `eslint-config`
30+
- `js-themes-toolkit`
31+
- `js-toolkit`
32+
- `npm-tools`
33+
34+
And package names such as:
35+
36+
- `changelog-generator`
37+
- `js-publish`
38+
- `npm-scripts`
39+
- `workspace-scripts`
40+
41+
As well as the scope of `monorepo` to label cross-cutting changes that affect multiple projects and packages in the monorepo.
42+
43+
**NOTE:** The preceding lists are non-exhaustive and for illustration purposes.

0 commit comments

Comments
 (0)