Skip to content

Commit b610989

Browse files
committed
Add section on pre-commit
1 parent 5649d62 commit b610989

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,13 @@ To run the tests locally, you can simply run `pytest`.
3131
In CI, we run tests using [nox](https://nox.thea.codes/en/stable/index.html),
3232
which runs the test multiple times using different package versions. Run
3333
`poetry run nox` to run the entire test suite.
34+
35+
### Pre-commit, linting
36+
37+
We use [pre-commit](https://pre-commit.com/) to manage git pre-commit hooks. This
38+
will fail linting locally so you can see errors before they run in CI. Run `pre-commit install`
39+
to install the hooks.
40+
41+
To run them manually, run `pre-commit run --all-files`.
42+
43+
To skip them when committing, run `git commit` with the `--no-verify` flag.

0 commit comments

Comments
 (0)