Skip to content

Commit ea2c9a4

Browse files
committed
docs(contributing): update with sub-headings and commitlint details
1 parent 6df9c95 commit ea2c9a4

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Commit message formatting
44

5+
### Automation of multiple processes
6+
57
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.
68
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.
79

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

30+
### Linting commit messages in Travis CI
31+
32+
This repo uses [`commitlint`](https://github.com/conventional-changelog/commitlint) for checking commit messages during CI testing.
33+
This ensures that they are in accordance with the `semantic-release` settings.
34+
35+
For more details about the default settings, refer back to the `commitlint` [reference rules](https://conventional-changelog.github.io/commitlint/#/reference-rules).
36+
37+
### Relationship between commit type and version bump
38+
2839
This formula applies some customisations to the defaults, as outlined in the table below,
2940
based upon the [type](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type) of the commit:
3041

0 commit comments

Comments
 (0)