Skip to content

Commit

Permalink
docs: add content from the wiki page "Contributing"
Browse files Browse the repository at this point in the history
  • Loading branch information
bajtos committed Feb 19, 2018
1 parent be837c1 commit 5dd5eb0
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ The **type** must be one of the following:

The **scope** must be a list of one or more packages contained in this monorepo. Each scope name must match a directory name in [packages/](../packages), e.g. `core` or `context`.

_Note: If multiple packages are affected by a pull request, don't list the scopes as the commit linter currently only supports only one scope being listed at most. The `CHANGELOG` for each affected package will still show the commit. Commit linter will be updated to allow listing of multiple affected scopes, see [issue #581](https://github.com/strongloop/loopback-next/issues/581)_

#### subject

Expand All @@ -156,12 +157,24 @@ The **body** provides more details, it should include the motivation for the cha

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes"a

Paragraphs or bullet points are ok (must not exceed 100 characters per line). Typically a hyphen or asterisk is used for the bullet, followed by a single space, with blank lines in between, but conventions vary here.

#### footer (optional)

The **footer** should contain any information about Breaking Changes introduced by this commit.

This section must start with the upper case text `BREAKING CHANGE` followed by a colon (`:`) and a space (` `). A description must be provided, describing what has changed and how to migrate from older versions.

### Tools to help generate a commit message

This repository has [commitizen](https://github.com/commitizen/cz-cli) support enabled. Commitizen can help you generate your commit messages automatically. You must install it globally as follows:

```sh
$ npm i -g commitizen
```

And to use it, simply call `git cz` instead of `git commit`. The tool will help you generate a commit message that follows the above guidelines.

## Releasing new versions

When we are ready to tag and publish a release, run the following commands:
Expand Down

0 comments on commit 5dd5eb0

Please sign in to comment.