From 4cd4cab6c5a5a15d9f0dd67df15cb09660b4bc36 Mon Sep 17 00:00:00 2001 From: Greg Hurrell Date: Wed, 3 Feb 2021 09:31:18 +0100 Subject: [PATCH 1/3] docs: link to general guidelines from CONTRIBUTING.md Based on conversation here: https://github.com/liferay/liferay-frontend-projects/pull/389#issuecomment-770646774 which was about not finding contributing guidelines for how to format commit messages. We could still use some more specific docs about what scopes we'd like to see when working in the monorepo (eg. using scopes to indicate project), so I'll put that in the next commit. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44b5a4d610..5836bc6722 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) From bf14c9d93c37dbefcc3b3fe7f43c1ce38af0a291 Mon Sep 17 00:00:00 2001 From: Greg Hurrell Date: Wed, 3 Feb 2021 09:46:16 +0100 Subject: [PATCH 2/3] docs: list recommended Conventional Commit scopes --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5836bc6722..981f1a9c2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,3 +21,23 @@ These apply to any work at Liferay, including in this monorepo: - [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. From b02b73d9241c8ec84cf2da7b620a6f5cac8d8539 Mon Sep 17 00:00:00 2001 From: Greg Hurrell Date: Fri, 5 Feb 2021 10:30:10 +0100 Subject: [PATCH 3/3] docs(guidelines): fix broken links As pointed out here: https://github.com/liferay/liferay-frontend-projects/pull/391#issuecomment-772347912 --- guidelines/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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