diff --git a/.travis.yml b/.travis.yml index d004d5512..0a85f1888 100644 --- a/.travis.yml +++ b/.travis.yml @@ -65,5 +65,4 @@ jobs: - stage: release script: - - npm install --no-save conventional-changelog-eslint - npx semantic-release diff --git a/docs/Maintenance.md b/docs/Maintenance.md index 8574b7e8c..ab10a9d81 100644 --- a/docs/Maintenance.md +++ b/docs/Maintenance.md @@ -15,35 +15,119 @@ Help us develop and maintain Styleguidist: ## Commit message conventions -We use [ESLint commit message conventions](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint). +We use a simplified [Angular commit message conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit). This makes automated releases with [semantic-release](https://github.com/semantic-release/semantic-release) possible. -Each commit looks like this: +\*\*The main differences with the Angular convention is that all messages are capitalized. Commit messages are written for humans to read, so we should use text convention for humans, not for machines. + +Hovewer, we commit messages should follow a ceratain structure, so they semantic-release could generate nice human-readalbe changelogs. + +**The commit message** consists of a `header`, a `body`, and a `footer`: ``` -Tag: Short description (fixes #1234) +
+ + + +