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

Rise total repo testing to 97% #476

Open
adnanhemani opened this issue Oct 7, 2020 · 8 comments
Open

Rise total repo testing to 97% #476

adnanhemani opened this issue Oct 7, 2020 · 8 comments

Comments

@adnanhemani
Copy link
Member

Due to the relatively-high activity on this repo, I'm putting down one of my larger goals in hopes that maybe people will help chip in on this!

I'm looking to rise the total repo testing percentage up to 97+% from the current 89% (I'll consider this issue closed at 97%).

For those just starting out with this, here's a few pointers:

  • Take a look at the Coveralls report on the master branch. You can click on individual files after expanding the repo "Tree" on this page.
  • Each source file will show green or red if a test covers a line of code. Of course, less red is better - and adding tests to our test suite will help make those "red" lines of code into "green" ones :)
  • The test suite can be found here. You can put new tests in either the respective ipynb file or the PyTest files. You should always try to instrument the test using the PyTest file first - but if the output of a function is a graph or something that isn't easily testable by using assert statements, you can put it in the ipynb file.

Last thing, please try to make as many individual PRs on this as possible - only group test changes into the same PR if they're pertaining to the same function/functionality. Otherwise, create separate PRs for all new changes, please!

Thanks to all the new contributors to this repo - we appreciate your help!

@davidwagner
Copy link
Member

@MarthaDs, great, would be wonderful to have help! I would not anticipate assigning a single individual to this issue -- rather, I imagine we'll get there through incremental progress, and that seems like something that we could easily have multiple people working on. Can I encourage you to pick some part of the code and prepare a small Pull Request that increases coverage on that code?

@athossampayo
Copy link
Contributor

athossampayo commented Oct 19, 2020

Did two PRs related, hope it's all good there. Separated in two PRs as asked too. Any problem let me know! 🚀

@skp-github
Copy link

@adnanhemani @davidwagner based on your comments, just wanted to let you guys know that i will start to work on this now

adnanhemani added a commit that referenced this issue Feb 11, 2021
Added ValueError testing for util.table_apply as asked in issue #476
adnanhemani added a commit that referenced this issue Feb 11, 2021
Added testing to function util.plot_normal_cdf as asked in issue #476
@davidwagner
Copy link
Member

Hi all, thank you for your willingness to contribute! We'd welcome your help. No need to request permission to contribute -- you are welcome to find a spot where we could have better test coverage, write a useful test, and submit a PR adding that test, and we'll review the PR when we're able. I'm a bit slow in getting to them, and I apologize in advance for that. I suggest breaking changes down into small PRs (as e.g. jr-42 has been doing).

@adnanhemani
Copy link
Member Author

As the Github Issue status suggests, this is still open. Please follow @davidwagner's comment above for potential changes.

@adnanhemani
Copy link
Member Author

@samanth2012 please view comments above: #476 (comment)

Contributing to open-source is not a form of tutoring, it requires contributors to take initiative and work on issues/feature requests they (or others) have seen in the repository and attempt to fix them without oversight from repository maintainers. Please do not ask for support on "how to get started" or "guidance on how to contribute", everything you need to contribute is located within this repository in the Markdown files. Hope this helps.

@data-8 data-8 deleted a comment from mardntas Jul 25, 2023
@data-8 data-8 deleted a comment from amoghkokari Jul 25, 2023
@data-8 data-8 deleted a comment from samanth2012 Jul 25, 2023
@data-8 data-8 deleted a comment from THEGAMECHANGER416 Oct 12, 2023
@add-itya
Copy link

I was looking at the Coveralls report link, and when I expand the "Tree" section and select the "tables.py" file, it gives me a gateway error. Is there any workaround for this?

@adnanhemani
Copy link
Member Author

@add-itya I've noticed this too :( it's likely a service issue with Coveralls. In the meantime, you can check out the repo and run the tests locally as well. You can generate the local report for coverage and use that too

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

No branches or pull requests

5 participants