Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bekabyx committed Jul 28, 2023
1 parent 161943b commit cb5c703
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,14 @@ The project uses [Black](https://black.readthedocs.io/en/stable/) for code forma

black .

Additionally, this project uses [ruff](https://beta.ruff.rs/docs/) for linting. You can run it with:

ruff .

ruff has in-built functionality to fix common linting errors. Use the `--fix` option to do this.

Both Black and ruff are both automatically called as part of pytest in this project.

A pre-commit hook is defined in the project to run it automatically before each commit. See the [pre-commit docs](https://pre-commit.com/#quick-start) for more information, or simply run the below command to setup:

pre-commit install
Expand Down

0 comments on commit cb5c703

Please sign in to comment.