Skip to content

Commit fde79d8

Browse files
authored
Merge pull request #391 from liferay/wincent/link-to-guidelines-from-contributing
docs: link to general guidelines and list recommended scopes
2 parents 2e0204a + b02b73d commit fde79d8

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Contributing
22

3+
## General guidelines
4+
5+
These apply to any work at Liferay, including in this monorepo:
6+
7+
- [Guidelines](guidelines) (in particular, see the [`guidelines/general`](guidelines/general) directory).
8+
39
## Project-specific contribution guidelines
410

511
- [`eslint-config`](projects/eslint-config/CONTRIBUTING.md)
@@ -15,3 +21,23 @@
1521
- [Creating a project](CONTRIBUTING/creating-a-project.md)
1622
- [Importing a project](CONTRIBUTING/importing-a-project.md)
1723
- [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.

guidelines/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![guidelines](https://github.com/liferay/liferay-frontend-projects/workflows/guidelines/badge.svg)
44

5-
This is a live (changing) repository containing [general](/general) and [Liferay DXP-specific](/dxp) guidelines for doing Frontend Development at Liferay Inc.
5+
This is a live (changing) repository containing [general](general) and [Liferay DXP-specific](dxp) guidelines for doing Frontend Development at Liferay Inc.
66

77
## Guideline development
88

0 commit comments

Comments
 (0)