Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
tidy up testing section
  • Loading branch information
Yobmod committed Jul 19, 2021
1 parent 9a587e1 commit f0bc672
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Expand Up @@ -106,19 +106,20 @@ On *Windows*, make sure you have `git-daemon` in your PATH. For MINGW-git, the
exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine
with MINGW's.

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

To lint, run `flake8`
To typecheck, run `mypy -p git`
To test, `pytest`
To lint, run: `flake8`

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

The same linting and testing will also be performed against different supported python versions
upon submitting a pull request (or on each push if you have a fork with a "main" branch).
To test, run: `pytest`

Configuration for flake8 is in the root/.flake8 file.
Configurations for mypy, pytest and coverage.py are in root/pyproject.toml.

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


### Contributions
Expand Down

0 comments on commit f0bc672

Please sign in to comment.