Skip to content

Added Testing information for Devs in README.md #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 2, 2020
Merged

Added Testing information for Devs in README.md #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d33bac2
improved README.md
iamrajiv Feb 24, 2020
fbaacb9
corrected previous mistakes in README.md
iamrajiv Feb 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down