From 240ba606e4835ecfcf85363d83b5b1bb1300eda5 Mon Sep 17 00:00:00 2001 From: Jordan Knott Date: Thu, 20 Aug 2020 18:17:07 -0500 Subject: [PATCH] docs(CONTRIBUTING): add section on how to install pre-commit hooks --- .pre-commit-config.yaml | 5 ++--- CONTRIBUTING.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 630d4ae..e5316be 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,7 +16,6 @@ repos: rev: master - hooks: - id: commitizen - stages: - - commit-msg + stages: [commit-msg] repo: https://github.com/commitizen-tools/commitizen - rev: v2.1.0 + rev: master diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03654d9..f6f43c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 - 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