From b8f9d4c4f8ecd67530565dfd3c928e4bf68d629c Mon Sep 17 00:00:00 2001 From: Jendrik Seipp Date: Sun, 8 Jan 2023 19:15:56 +0100 Subject: [PATCH] Recommend pre-commit. --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 511214f3..265120d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ install in development mode: $ pip install --editable . -### Installing tox +### Installing test tools Vulture uses tox for testing. You can read more about it in the [tox documentation](https://tox.readthedocs.io). @@ -57,6 +57,12 @@ To install `tox`, run: $ pip install tox +It's also recommended that you use `pre-commit` to catch style errors +early: + + $ pip install pre-commit + $ pre-commit install + ## Coding standards ### Creating a new branch