Skip to content

Commit

Permalink
docs: Fix incorrect symlink example for the pre-commit hooks (#214)
Browse files Browse the repository at this point in the history
It should use an absolute path.
  • Loading branch information
aborgna-q authored Nov 6, 2023
1 parent 4220038 commit b358c02
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit b358c02

Please sign in to comment.