Skip to content

Commit 4aec2b4

Browse files
committed
Add pre-commit instructions in DEVELOPMENT guide
1 parent f044506 commit 4aec2b4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

.github/DEVELOPMENT.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,18 @@ With `-e` passed to `pip install` above pip can reference the code you are
2525
modifying in the *virtual env*. That way, you do not need to run `pip install`
2626
again to make your changes applied to the *virtual env*.
2727

28+
### `pre-commit` checks
29+
30+
Code is automatically checked on commit by a [pre-commit](https://pre-commit.com/) git hook.
31+
32+
Following checks are performed:
33+
34+
- [`isort`](https://pycqa.github.io/isort/) for sorting imports
35+
- [`flake8`](https://flake8.pycqa.org/en/latest/) for code linting
36+
- [`mypy`](https://mypy.readthedocs.io/en/stable/) for static type checking
37+
38+
Install the git hook by executing `pre-commit install`.
39+
2840
## Running tests
2941

3042
`trino-python-client` uses [pytest](https://pytest.org/) for its tests. To run

0 commit comments

Comments
 (0)