Skip to content

Commit 181afd7

Browse files
committed
Detail pre-commit usage in README
1 parent ec72068 commit 181afd7

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

test-data/unit/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ First install any additional dependencies needed for testing:
100100

101101
python3 -m pip install -U -r test-requirements.txt
102102

103+
Configure `pre-commit` to run the linters automatically when you commit:
104+
105+
pre-commit install
106+
103107
The unit test suites are driven by the `pytest` framework. To run all mypy tests,
104108
run `pytest` in the mypy repository:
105109

@@ -157,7 +161,9 @@ To run mypy on itself:
157161

158162
python3 -m mypy --config-file mypy_self_check.ini -p mypy
159163

160-
To run the linter:
164+
To run the linter (this commands just wraps `pre-commit`, so you can also
165+
invoke it directly like `pre-commit run -a`, and this will also run when you
166+
`git commit` if enabled):
161167

162168
python3 runtests.py lint
163169

0 commit comments

Comments
 (0)