Skip to content

Commit ebf5813

Browse files
authored
Added Testing information for Devs in README.md (#97)
1 parent 93e7cc4 commit ebf5813

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,16 @@ python3 setup.py develop
2727

2828
Make sure that your python version is above `3.5`.
2929

30+
Testing
31+
-------
32+
33+
For testing your patch locally follow the steps given below,
34+
35+
1. Install [pytest-cov](https://pypi.org/project/pytest-cov/). Skip this step if you are already having the package.
36+
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.
37+
3038
Why we use Python?
31-
-----------------
39+
------------------
3240

3341
As we know Python is an interpreted language and hence is slow as compared to C++, the most
3442
popular language for sports programming. We still decided to use Python because the software

0 commit comments

Comments
 (0)