Skip to content
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.

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

Add information for Devs in README.md #96

Closed
czgdp1807 opened this issue Feb 23, 2020 · 4 comments · Fixed by #97
Closed

Add information for Devs in README.md #96

czgdp1807 opened this issue Feb 23, 2020 · 4 comments · Fixed by #97
Labels
documentation Improvements or additions to documentation

Comments

@czgdp1807
Copy link
Member

Description of the problem

Currently, the README.md has very little information for developers/contributors.
IMO, the following should be added after https://github.com/codezonediitj/pydatastructs#installation

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. 

Example of the problem

References/Other comments

@annu12340
Copy link

I would like to work on this issue

@czgdp1807
Copy link
Member Author

Hi @annu12340
This has already been done by #97
You can try #112 or make some improvements to the README on your own by adding information which you think should be there.

@annu12340
Copy link

ok

@czgdp1807
Copy link
Member Author

Fixed by #97

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants