From d6771729c598b17200c55eb53adadada85df4044 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Thu, 25 Nov 2021 09:38:19 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f2d32fe0..eea2bd60 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -191,7 +191,7 @@ $ make html The built documentation can then be found in `docs/_build/html/`. -To avoid committing code that violates our style guide, we strongly advise you to install [*pre-commit*][^dev] hooks: +To avoid committing code that violates our style guide, we strongly advise you to install [*pre-commit*] [^dev] hooks: ```console $ pre-commit install @@ -203,7 +203,8 @@ You can also run them anytime (as our tox does) using: $ pre-commit run --all-files ``` -[^dev]: *pre-commit* should have been installed into your virtualenv automatically when you ran `pip install -e '.[dev]'` above. If pre-commit is missing, it may be that you need to re-run `pip install -e '.[dev]'`. +[^dev]: *pre-commit* should have been installed into your virtualenv automatically when you ran `pip install -e '.[dev]'` above. + If *pre-commit* is missing, your probably need to run `pip install -e '.[dev]'` again. Governance