Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@

## Linting

Linting is run on the CI using [pre-commit](https://pre-commit.com/), and can be run
locally:
Linting is run on the CI using [prek](https://prek.j178.dev//), and can be run locally:

```sh
pip install pre-commit
pre-commit install # optional: to run when you commit, on just the staged changes
pre-commit run --all-files # to run on all files now
pip install prek
prek install # optional: to run when you commit, on just the staged changes
prek run --all-files # to run on all files now
```

## Docstrings
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- uses: actions/setup-python@v6
with:
python-version: "3.x"
- uses: tox-dev/action-pre-commit-uv@v1
- uses: j178/prek-action@v1

mypy:
runs-on: ubuntu-latest
Expand Down
6 changes: 2 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@ commands =
[testenv:lint]
skip_install = true
deps =
pre-commit-uv
pass_env =
PRE_COMMIT_COLOR
prek
commands =
pre-commit run --all-files --show-diff-on-failure
prek run --all-files --show-diff-on-failure

[testenv:mypy]
deps =
Expand Down
Loading