Skip to content

docs: link to general guidelines and list recommended scopes #391

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

Merged
merged 3 commits into from
Feb 5, 2021
Merged

docs: link to general guidelines and list recommended scopes #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4cd4cab
docs: link to general guidelines from CONTRIBUTING.md
wincent Feb 3, 2021
bf14c9d
docs: list recommended Conventional Commit scopes
wincent Feb 3, 2021
b02b73d
docs(guidelines): fix broken links
wincent Feb 5, 2021
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
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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.
2 changes: 1 addition & 1 deletion guidelines/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down