greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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.
pull/18182/head
Josh Alling 2018-08-09 21:12:47 -06:00 committed by Kristofer Koishigawa
parent b369fa00cb
commit 16d52cbcdf
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CONTRIBUTING.md
View File

@ -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).