Updating Readme.md file to detail how to get local testing/coverage report #610
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adnanhemani
requested changes
Feb 26, 2024
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[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%.