Skip to content

Commit f0bc672

Browse files
authored
Update README.md
tidy up testing section
1 parent 9a587e1 commit f0bc672

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

‎README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,20 @@ On *Windows*, make sure you have `git-daemon` in your PATH. For MINGW-git, the
106106
exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine
107107
with MINGW's.
108108

109-
Ensure testing libraries are installed. In the root directory, run: `pip install test-requirements.txt`
110-
Then,
109+
Ensure testing libraries are installed.
110+
In the root directory, run: `pip install -r test-requirements.txt`
111111

112-
To lint, run `flake8`
113-
To typecheck, run `mypy -p git`
114-
To test, `pytest`
112+
To lint, run: `flake8`
115113

116-
Configuration for flake8 is in root/.flake8 file.
117-
Configuration for mypy, pytest, coverage is in root/pyproject.toml.
114+
To typecheck, run: `mypy -p git`
118115

119-
The same linting and testing will also be performed against different supported python versions
120-
upon submitting a pull request (or on each push if you have a fork with a "main" branch).
116+
To test, run: `pytest`
117+
118+
Configuration for flake8 is in the root/.flake8 file.
119+
Configurations for mypy, pytest and coverage.py are in root/pyproject.toml.
121120

121+
The same linting and testing will also be performed against different supported python versions
122+
upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled).
122123

123124

124125
### Contributions

0 commit comments

Comments
 (0)