From b358c02fbdb798091f3a229dbf9949594f7c6db2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Agust=C3=ADn=20Borgna?= <121866228+aborgna-q@users.noreply.github.com> Date: Mon, 6 Nov 2023 10:04:18 +0100 Subject: [PATCH] docs: Fix incorrect symlink example for the pre-commit hooks (#214) It should use an absolute path. --- DEVELOPMENT.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 2f2e1530..fa652e55 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -32,6 +32,7 @@ To setup the environment manually you will need: - Poetry: https://python-poetry.org/ + Simply run `poetry shell` to activate an environment with all the required dependencies. ## 🏃 Running the tests @@ -70,9 +71,9 @@ You can use the script in [`.github/pre-commit`](.github/pre-commit) to run the To automatically check that before each commit, install it as a hook with: ```bash -ln -s .github/pre-commit .git/hooks/pre-commit +ln -s .github/pre-commit $PWD/.git/hooks/pre-commit # Or, to check before pushing instead -ln -s .github/pre-commit .git/hooks/pre-push +ln -s .github/pre-commit $PWD/.git/hooks/pre-push ``` ## 💅 Coding Style