Skip to content
This repository has been archived by the owner on Sep 25, 2019. It is now read-only.

Commit

Permalink
docs(contributing): add info on conventional commit messages
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
joshalling authored and scissorsneedfoodtoo committed Aug 12, 2018
1 parent b369fa0 commit 16d52cb
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 16d52cb

Please sign in to comment.