From 4790f3fc22ddcc7b4d9040c1f29fba2638d99cd9 Mon Sep 17 00:00:00 2001 From: Artem Sapegin Date: Wed, 2 Sep 2020 11:30:53 +0200 Subject: [PATCH] =?UTF-8?q?chore:=20Switch=20to=20Angular=20commit=20conve?= =?UTF-8?q?ntion=20=F0=9F=A6=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #1673 --- .travis.yml | 1 - docs/Maintenance.md | 127 ++++++++++++++++++++++++++++++++++++-------- release.config.js | 18 ------- 3 files changed, 106 insertions(+), 40 deletions(-) delete mode 100644 release.config.js 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) +
+ + + +