diff --git a/README.md b/README.md index efa2646ee..2ac694e73 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,16 @@ python3 setup.py develop Make sure that your python version is above `3.5`. +Testing +------- + +For testing your patch locally follow the steps given below, + +1. Install [pytest-cov](https://pypi.org/project/pytest-cov/). Skip this step if you are already having the package. +2. Run, `python3 -m pytest --doctest-modules --cov=./ --cov-report=html`. Look for, `htmlcov/index.html` and open it in your browser, which will show the coverage report. Try to ensure that the coverage is not decreasing by less than 1% for your patch. + Why we use Python? ------------------ +------------------ As we know Python is an interepreted language and hence is slow as compared to C++, the most popular language for sports programming. We still decided to use Python because the software