From ea2c9a403d2eb08cd8c2e07b9c0b98fff1da901e Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Fri, 22 Feb 2019 03:26:49 +0000 Subject: [PATCH] docs(contributing): update with sub-headings and `commitlint` details --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89765e22..01c413cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -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: