Skip to content

Commit

Permalink
Add section on pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
dantheman39 committed Jan 13, 2024
1 parent 9d6bbf3 commit c96e15f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,13 @@ To run the tests locally, you can simply run `pytest`.
In CI, we run tests using [nox](https://nox.thea.codes/en/stable/index.html),
which runs the test multiple times using different package versions. Run
`poetry run nox` to run the entire test suite.

### Pre-commit, linting

We use [pre-commit](https://pre-commit.com/) to manage git pre-commit hooks. This
will fail linting locally so you can see errors before they run in CI. Run `pre-commit install`
to install the hooks.

To run them manually, run `pre-commit run --all-files`.

To skip them when committing, run `git commit` with the `--no-verify` flag.

0 comments on commit c96e15f

Please sign in to comment.