Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions on CLI usage of pylint and pytype #358

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Add instructions on CLI usage of pylint and pytype #358

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ececfb
Add instructions on CLI usage of pylint and pytype
boomanaiden154 Sep 6, 2024
678dd07
Address feedback
boomanaiden154 Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/contributing.md
View file
Open in desktop
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 .
boomanaiden154 marked this conversation as resolved.
Show resolved Hide resolved
```

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
Loading