Skip to content

Include mypy instructions in CONTRIBUTING.md #4271

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.

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

Merged
merged 10 commits into from
Mar 19, 2021
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ We want your work to be readable by others; therefore, we encourage you to note
return a + b
```

Instructions on how to install mypy can be found [here](https://github.com/python/mypy). Please use the command `mypy . --ignore-missing-imports` to test all files or `mypy path_to_file.py --ignore-missing-imports` to test one specific file.

- [__List comprehensions and generators__](https://docs.python.org/3/tutorial/datastructures.html#list-comprehensions) are preferred over the use of `lambda`, `map`, `filter`, `reduce` but the important thing is to demonstrate the power of Python in code that is easy to read and maintain.

- Avoid importing external libraries for basic algorithms. Only use those libraries for complicated algorithms.
Expand Down