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

Improve test coverage #31

Open
ReubenJ opened this issue Sep 27, 2024 · 2 comments
Open

Improve test coverage #31

ReubenJ opened this issue Sep 27, 2024 · 2 comments
Assignees
Labels

Comments

@ReubenJ
Copy link
Member

ReubenJ commented Sep 27, 2024

↩️ Back to the main Herb.jl Hacktoberfest issue


This repository currently has 28% test coverage. It shouldn't take too much work to bring this close to 100%. The absolute number of lines missing coverage is not high, but the code might look a little weird upon first examining it. Plan to take a few minutes to familiarize yourself with the interpret function in particular.

Suggested steps:

  1. If you're new to Herb, please take a look at our getting started guide and CONTRIBUTING.md.
  2. Check the current test coverage on Codecov.
  3. Following the CONTRIBUTING.md guide, set up your own fork of HerbInterpret and take a look at the existing tests.
  4. We would suggest creating two new files, each with a test set: one for deprecations and one for the interpret(...)/call_func(...) function tests
    • For the deprecated functions missing coverage, @test_deprecated is sufficient.
    • For the interpret/call_func tests, aim to increase the coverage to 100%! (but any increase is much appreciated 🤗 )
  5. Open a PR with your new tests to verify CI passes and that the coverage is what you expect

Don't hesitate to reach out here for any clarifications. Happy hacking!

@mtahashahid
Copy link

Hey @ReubenJ can you assign this issue to me??

@ReubenJ
Copy link
Member Author

ReubenJ commented Nov 14, 2024

@mtahashahid were you able to add some tests in the end?

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

No branches or pull requests

3 participants