docs(contributing): add info on conventional commit messages - Githubissues

freeCodeCamp / curriculum

The freeCodeCamp curriculum and lesson editor

Creative Commons Attribution Share Alike 4.0 International

81 stars 124 forks source link

docs(contributing): add info on conventional commit messages #234

Closed joshalling closed 6 years ago

joshalling commented 6 years ago

Description

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.

Pre-Submission Checklist

[x] Your pull request targets the dev branch.
[ ] Branch starts with either fix/, feature/, or translate/ (e.g. fix/challenge-tests)
[x] All new and existing tests pass the command npm test.
[x] Use npm run commit to generate a conventional commit message. Learn more here: https://conventionalcommits.org/#why-use-conventional-commits
[x] The changes were done locally on your machine and NOT GitHub web interface. If they were done on the web interface you have ensured that you are creating conventional commit messages.

Checklist:

[x] Tested changes locally.
[ ] Addressed currently open issue (replace XXXXX with an issue no in next line)

Closes #XXXXX

scissorsneedfoodtoo commented 6 years ago

@joshalling, thank you for this much needed improvement! Everything LGTM :+1: