diff --git a/README.md b/README.md index 06021925..6fb3f496 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,13 @@ pip install -r requirements.txt This project uses approval tests to ensure the behavior of the code remains the same during refactoring + +```bash +coverage run --branch -m pytest --approvaltests-add-reporter=diffuse -s ; coverage html ; coverage report --fail-under=100 +``` + +This will run the tests, and will also: + +- automatically bring up [diffuse](TODO: link to) to view differences side by side, if there are any behavior changes +- warn you if your coverage falls below 100% (either you need more tests, or there is dead code) +- generate a coverage report (You can view this in the `htmlcov` directory by opening `index.html` in a browser) diff --git a/requirements.txt b/requirements.txt index feb57930..4580ae0d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ pytest approvaltests pytest-approvaltests coverage +diffuse