matrix-org / synapse

Synapse: Matrix homeserver written in Python/Twisted.
https://matrix-org.github.io/synapse
Apache License 2.0
11.8k stars 2.13k forks source link

Add note in CONTRIBUTING.md about ways to run the mypy type checker. #8601

Closed ShadowJonathan closed 3 years ago

ShadowJonathan commented 3 years ago

Per @clokep's comment, maybe adding something along the following lines to CONTRIBUTING.md would be nice:

devanshushah1 commented 3 years ago

Per @clokep's comment, maybe adding something along the following lines to CONTRIBUTING.md would be nice:

  • Something about being able to use tox -e mypy to do a isolated lint check.
  • Something about being able to do pip install -e .[mypy] to install the right mypy version in venv, to be able to execute mypy by itself (which can be faster than running it through tox)

i agree