Skip to content

Commit

Permalink
Add pre-commit instructions in DEVELOPMENT guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mdesmet committed Oct 27, 2022
1 parent f044506 commit 4aec2b4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4aec2b4

Please sign in to comment.