Herb-AI/HerbInterpret.jl

Improve test coverage

Open

#31 opened on Sep 27, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Julia (2 forks)auto 404
good first issuehacktoberfest

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

↩️ 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!

Contributor guide

Research direction
Familiarize yourself with the interpret function and existing tests, then create test files for deprecations and interpret/call func to improve coverage.
Tech stack
julia
Domain
testing
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75