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

Updating Readme.md file to detail how to get local testing/coverage report #610

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

add-itya
Copy link

[X] Updated Readme.md file

Changes proposed:
Before I started developing, I noticed that my Windows OS caused some issues when generating the testing reports. Using pytest/coverage, I got different percentages and even errors. The errors were because some functions that were being used were only available on Unix/Linux systems. So, I had to install WSL and work around this to gain an accurate report. This way, I could add tests more effectively and help get the overall testing coveralls report to 97%.

@coveralls
Copy link

Coverage Status

coverage: 94.935%. remained the same
when pulling 0ec3d35 on add-itya:master
into 9a200e0 on data-8:master.

Copy link
Member

@adnanhemani adnanhemani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @add-itya - so sorry for the delay to review this. Can you please merge these into the DEVELOPERS.md file instead? The README.md is supposed to be a much more general file and people working on the library (including testing) should ideally be looking at that file instead. Please let me know if you have any questions. Thanks for this - I'm sure it will be very helpful to Windows developers in the future!


That's it! You have now successfully set up your local development environment and generated a test report.

After reviewing the results, you can determine which of the files under the source code folder need more tests based on their corresponding percentages.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to add the lines from here onwards :)

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

Successfully merging this pull request may close these issues.

3 participants