orhun/git-cliff

Increase test coverage

Open

#658 opened on May 26, 2024

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Rust (308 forks)auto 404
feature/requestgood first issuehelp wanted

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

The test coverage of git-cliff is kinda low (around 40%).

We need more unit & integration tests.

Desired solution

Just add more unit & integration tests.

Alternatives considered

None.

Additional context

We also have fixture tests for testing the functionality but we should prioritize unit tests too!

Contributor guide

Research direction
Explore the existing test structure in git cliff and identify areas with low coverage. Write unit tests for key functions and integration tests using the fixture tests as examples.
Tech stack
rust
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
Rustcargo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70