diff --git a/.github/DEVELOPMENT.md b/.github/DEVELOPMENT.md index acd934b9..503f1a52 100644 --- a/.github/DEVELOPMENT.md +++ b/.github/DEVELOPMENT.md @@ -25,6 +25,18 @@ With `-e` passed to `pip install` above pip can reference the code you are modifying in the *virtual env*. That way, you do not need to run `pip install` again to make your changes applied to the *virtual env*. +### `pre-commit` checks + +Code is automatically checked on commit by a [pre-commit](https://pre-commit.com/) git hook. + +Following checks are performed: + +- [`isort`](https://pycqa.github.io/isort/) for sorting imports +- [`flake8`](https://flake8.pycqa.org/en/latest/) for code linting +- [`mypy`](https://mypy.readthedocs.io/en/stable/) for static type checking + +Install the git hook by executing `pre-commit install`. + ## Running tests `trino-python-client` uses [pytest](https://pytest.org/) for its tests. To run