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

Add mypy to style guidelines #1841

Merged
merged 2 commits into from
May 22, 2023
Merged

Add mypy to style guidelines #1841

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b325929
mypy
purva-thakre May 19, 2023
b4b1936
change wording
purva-thakre May 19, 2023
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
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ If above format check fails then you will be presented with a [diff](https://bla
```bash
make format
```
We also use [Mypy](https://mypy.readthedocs.io/en/stable/) as a type checker to find incompatible types compared to the type
hints in your code. To test this locally, run the type check test in the top-level directory of the repository.

To find incorrectly used types by type checking in `mypy`, use
```bash
make check-types
```

If you aren't presented with any errors, then that means your code is ready to commit!

Expand Down