diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44b5a4d610..981f1a9c2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,11 @@ # Contributing +## General guidelines + +These apply to any work at Liferay, including in this monorepo: + +- [Guidelines](guidelines) (in particular, see the [`guidelines/general`](guidelines/general) directory). + ## Project-specific contribution guidelines - [`eslint-config`](projects/eslint-config/CONTRIBUTING.md) @@ -15,3 +21,23 @@ - [Creating a project](CONTRIBUTING/creating-a-project.md) - [Importing a project](CONTRIBUTING/importing-a-project.md) - [Migrating an npm package to the `@liferay` named scope](CONTRIBUTING/migrating-an-npm-package-to-the-liferay-named-scope.md) + +## Conventional commit scopes + +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: + +- `eslint-config` +- `js-themes-toolkit` +- `js-toolkit` +- `npm-tools` + +And package names such as: + +- `changelog-generator` +- `js-publish` +- `npm-scripts` +- `workspace-scripts` + +As well as the scope of `monorepo` to label cross-cutting changes that affect multiple projects and packages in the monorepo. + +**NOTE:** The preceding lists are non-exhaustive and for illustration purposes. diff --git a/guidelines/README.md b/guidelines/README.md index f676eadc90..6a699206ff 100644 --- a/guidelines/README.md +++ b/guidelines/README.md @@ -2,7 +2,7 @@ ![guidelines](https://github.com/liferay/liferay-frontend-projects/workflows/guidelines/badge.svg) -This is a live (changing) repository containing [general](/general) and [Liferay DXP-specific](/dxp) guidelines for doing Frontend Development at Liferay Inc. +This is a live (changing) repository containing [general](general) and [Liferay DXP-specific](dxp) guidelines for doing Frontend Development at Liferay Inc. ## Guideline development