Skip to content

Commit

Permalink
also describe pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
leoschwarz committed Nov 7, 2024
1 parent 1769d1a commit 13db696
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,23 @@ uv pip install -e ".[dev]"
This creates the virtual environment in the `.venv` directory.
To activate the environment in your shell, you need to `source` the correct activation script from `.venv/bin`, e.g. `.venv/bin/activate` for bash.

### Install `pre-commit`

To check and format the code automatically, you can use `pre-commit`.
In general, you can use the latest version.

```bash
pipx install pre-commit
pre-commit install
```

Now, the checks will be run automatically before each commit.
The first time you might have some delay because the hooks are installed.

### Install `nox`

To run the tests the same way as in the CI, you can use `nox`.
In general, you can use the latest version.
It's suggested to install it with `pipx` but any other way is fine too.

```bash
pipx install nox
Expand Down

0 comments on commit 13db696

Please sign in to comment.