diff --git a/development.rst b/development.rst index 59ae67501c902787e20c0418a505b5d61abc7104..71e325be7c79dcce7f437f70f18281b8c2dcc20d 100644 --- a/development.rst +++ b/development.rst @@ -4,15 +4,15 @@ This section is for developers wanting to contribute to the project. Setup pre-commit hooks ---------------------- -The project uses [pre-commit](https://pre-commit.com/) to run some checks before committing code. -Install pre-commit by running the following command: +The project uses `pre-commit <https://pre-commit.com/>`__ to run some checks before committing code. +Install pre-commit by running the following command:: pip install pre-commit -To setup the pre-commit hooks, run the following command from the root of the project: +To setup the pre-commit hooks, run the following command from the root of the project:: pre-commit install Then every time you commit, pre-commit will run all checks defined in `.pre-commit-config.yaml`. -you can run the pre-commit checks manually by running: +you can run the pre-commit checks manually by running:: pre-commit run --all-files