Skip to content

Commit f587b21

Browse files
authored
Update README.md
Update testing section
1 parent 9f906b3 commit f587b21

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

Diff for: README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -106,18 +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-
The easiest way to run tests is by using [tox](https://pypi.python.org/pypi/tox)
110-
a wrapper around virtualenv. It will take care of setting up environments with the proper
111-
dependencies installed and execute test commands. To install it simply:
109+
Ensure testing libraries are installed. In the root directory, run: `pip install test-requirements.txt`
110+
Then,
112111

113-
pip install tox
112+
To lint, run `flake8`
113+
To typecheck, run `mypy -p git`
114+
To test, `pytest`
114115

115-
Then run:
116+
Configuration for flake8 is in root/.flake8 file.
117+
Configuration for mypy, pytest, coverage is in root/pyproject.toml.
116118

117-
tox
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).
118121

119122

120-
For more fine-grained control, you can use `unittest`.
121123

122124
### Contributions
123125

0 commit comments

Comments
 (0)