From 16d52cbcdfa412846437d53063c6c1ab9fc20ed1 Mon Sep 17 00:00:00 2001 From: Josh Alling Date: Thu, 9 Aug 2018 21:12:47 -0600 Subject: [PATCH] docs(contributing): add info on conventional commit messages Specifies that a pull request will fail the Travis CI build without conventional commit messages and adds a link with more info about conventional commits. --- docs/CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8e4ce407d31..471de6923ef 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -275,9 +275,11 @@ $ git add path/to/filename.ext You can also run `git add .` to add all unstaged files. Take care, though, because you can accidentally add files you don't want added. Review your `git status` first. -### Commit Your Changes +### Commit Your Changes -We have a [tool](https://commitizen.github.io/cz-cli/) that helps you make standard commit messages. Execute `npm run commit` and follow the steps. +We have a [tool](https://commitizen.github.io/cz-cli/) that helps you make standard commit messages. Execute `npm run commit` and follow the steps. This will generate a conventional commit message. + +**Note**: Your pull request will fail the Travis CI build if your commits do not have conventional messages. [Click here](https://conventionalcommits.org/#why-use-conventional-commits) to read more about conventional commit messages. If you want to add/remove changes to previous commit, [add the files](#making-your-changes), and use `git commit --amend` or `git commit --amend --no-edit` (to keep the same commit message).