docs(CONTRIBUTING): add section on how to install pre-commit hooks

This commit is contained in:
Jordan Knott 2020-08-20 18:17:07 -05:00
parent 2abbc49ef7
commit 240ba606e4
2 changed files with 3 additions and 4 deletions

View File

@ -16,7 +16,6 @@ repos:
rev: master rev: master
- hooks: - hooks:
- id: commitizen - id: commitizen
stages: stages: [commit-msg]
- commit-msg
repo: https://github.com/commitizen-tools/commitizen repo: https://github.com/commitizen-tools/commitizen
rev: v2.1.0 rev: master

View File

@ -25,7 +25,7 @@ The `description` is a decriptive summary of the change the PR will make.
- All PRs should be rebased (with master) and commits squashed prior to the final merge process - All PRs should be rebased (with master) and commits squashed prior to the final merge process
- One PR per fix or feature - One PR per fix or feature
- Setup & install [pre-commit hooks](https://pre-commit.com/#install) - Setup & install [pre-commit hooks](https://pre-commit.com/#install) then install the hooks `pre-commit install && pre-commit install --hook-type commit-msg`
### Git Commit Message Style ### Git Commit Message Style