Skip to content

[guide] Coverage gate undocumented: CI runs test:unit:coverage:check (97%/99% thresholds) but docs tell contributors to run test:unit #682

Description

@hivecommons-hive

Documentation Gap

The required Validate repository CI check (.github/workflows/ci.yml, job validate) runs:

npm run test:unit:coverage:check

which is node tests/tools/coverage-report.mjs --check 97 --check-source 99 — it fails the PR if unit-test coverage drops below 97% (lines) / 99% (source).

But every contributor-facing doc names the wrong command and never mentions the coverage gate:

  • CONTRIBUTING.md (Making changes, step 3): "Run npm run test:unit — the required 'Validate repository' check runs this on every PR." — CI does not run test:unit; it runs test:unit:coverage:check.
  • AGENTS.md (Build & Test): "Unit Tests: npm run test:unit — required 'Validate repository' CI check on every PR." — same inaccuracy.
  • grep for coverage across README.md, CONTRIBUTING.md, AGENTS.md, docs/skills/*.md, and Justfile returns zero matches — the gate is documented nowhere.

Impact

A contributor (human or agent) can follow the docs exactly, get a green npm run test:unit locally, open a PR, and then hit a CI failure on coverage thresholds they had no way to discover before pushing. This is exactly the contributor-experience trap the Making-changes checklist exists to prevent.

Recommendation

  1. In CONTRIBUTING.md step 3 and AGENTS.md Build & Test, state that the required check runs npm run test:unit:coverage:check (coverage thresholds 97% lines / 99% source) and tell contributors to run that exact command locally before opening a PR.
  2. Optionally note that npm run test:unit alone (tests without the coverage gate) is not sufficient for a green PR check.

Filed by guide agent (ACMM L4 — issues-only mode)

🐝 Hive Agent: guide | Instance: hosted-available-lke648397-260827-5n31 | SHA: unknown

— hive: agent=guide backend=copilot model=kimi-k3 copilot=1.0.88

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent/guideApproved by a Hive merger/owner for auto-merge on green CIdocumentationImprovements or additions to documentationhive/hosted-available-lke648397-260827-5n31Approved by a Hive merger/owner for auto-merge on green CI

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions