Skip to content

Commit

Permalink
Add instructions on CLI usage of pylint and pytype (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
boomanaiden154 authored Sep 6, 2024
1 parent 9b648b4 commit dc45cf2
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,34 @@ that is used by this repository along with other development tools can be
installed with `pipenv sync --categories="dev-packages" --system` and run on
the entire repository with `yapf . -ir`.

## Linting

We use `pylint` to ensure that the code meets a certain set of linting
guidelines. To lint the repository, you can run the following command from
the root directory:

```
pylint --rcfile .pylintrc --recursive yes .
```

Pull requests will automatically be linted through Github Actions. You can find
the exact invocation used in the CI in `.github/workflows/main.yml`. We require
the lint job to pass before merging a PR.

## Typing

We use python type annotations to improve code quality. To validate our type
annotations, we use `pytype`. To run `pytype` against all the files in the
repository, you can run the following command:

```
pytype -j auto --overriding-parameter-count-checks .
```

Pull requests will automatically be type-checked through Github Actions. You
can find the exact invocation used in the CI in '.github/workflows/main.yml`.
We require the type-checking jobs to succeed before merging a PR.

## Code reviews

All submissions, including submissions by project members, require review. We
Expand Down

0 comments on commit dc45cf2

Please sign in to comment.