Skip to content

docs: 80% Kover coverage floor is claimed in five places but the real per-module floors are 99% / 99% / 90% #91

Description

@OmarAlJarrah

Problem

Several places assert an 80% line-coverage floor:

  • .github/workflows/ci.yml:86 — comment: "koverVerify … enforces the 80% line-coverage rule"
  • README.md:16 — coverage badge
  • README.md:167 — prose: "an 80% Kover line-coverage floor"
  • site/src/content/docs/guides/building-from-source.mdx:21 — repeats the 80% figure

None of the three modules actually enforces an 80% line floor:

  • kuri/build.gradle.kts:232minBound(99, LINE)
  • kuri-bind/build.gradle.kts:94minBound(99, LINE)
  • kuri-serde-kotlinx/build.gradle.kts:86minBound(90, LINE)

The only "80" anywhere in the coverage configuration is a branch floor on kuri-serde-kotlinx, not a line floor on any module. The comment right next to the real rule in kuri/build.gradle.kts documents the 99% line floor, directly contradicting the CI comment and the public docs a few files away. The docs also don't mention the additional 85% branch floor kuri carries.

Impact

A contributor reads the 80% figure, adds code that's reachable at roughly 85% coverage expecting ./gradlew build to pass, and the actual 99% floor fails the build. The public README badge simultaneously understates the real coverage guarantee to anyone evaluating the library.

Suggested fix

Update all four locations to state the real per-module floors (99% line / 85% branch for kuri and kuri-bind, 90% line for kuri-serde-kotlinx), or generate the badge/doc text from the Gradle config so it can't drift again.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions