Skip to content

Commit

Permalink
docs(contributing): update with sub-headings and commitlint details
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed Feb 22, 2019
1 parent 6df9c95 commit ea2c9a4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Commit message formatting

### Automation of multiple processes

This repo uses [`semantic-release`](https://github.com/semantic-release/semantic-release) for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation.

Expand All @@ -25,6 +27,15 @@ So based on the example above:
* The `(scope):` will be shown in bold text without the brackets.
* The `subject` follows the `scope` as standard text.

### Linting commit messages in Travis CI

This repo uses [`commitlint`](https://github.com/conventional-changelog/commitlint) for checking commit messages during CI testing.
This ensures that they are in accordance with the `semantic-release` settings.

For more details about the default settings, refer back to the `commitlint` [reference rules](https://conventional-changelog.github.io/commitlint/#/reference-rules).

### Relationship between commit type and version bump

This formula applies some customisations to the defaults, as outlined in the table below,
based upon the [type](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type) of the commit:

Expand Down

0 comments on commit ea2c9a4

Please sign in to comment.