Skip to content

Add a doc-parity unit test pinning documented coverage thresholds to the enforced gates #1193

Closed

Description

@mrbobbytables

Problem: docs drift is being fixed per-instance, never as a class

10 of the last 100 closed issues were documentation-drift reports, and the same spots drift repeatedly:

The repository already proves the fix pattern works where it is applied:

But nothing pins the threshold numbers stated in CONTRIBUTING.md and AGENTS.md to the values the gate actually enforces (tests/coverage-gate-thresholds.test.mjs / ci.yml). As of today, AGENTS.md:40 and CONTRIBUTING.md:176 still say '94% regions' while the enforced gate is 95 — the exact drift #1189 is about to fix for the second time.

Proposed fix

Add a unit test (e.g. tests/docs-threshold-parity.test.mjs) that:

  1. Extracts the single source of truth for each gate (the --check-* flags asserted in tests/coverage-gate-thresholds.test.mjs and .github/workflows/ci.yml).
  2. Asserts every place CONTRIBUTING.md, AGENTS.md, and .github/copilot-instructions.md states those numbers matches.

Then the next ratchet PR fails locally until the docs are updated in the same commit, and the recurring guide-issue class ends.

Completion criteria

Activity

  1. added
    documentationImprovements or additions to documentation
    qualityApproved by a Hive merger/owner for auto-merge on green CI
    testingApproved by a Hive merger/owner for auto-merge on green CI
    on Oct 8, 2026
  2. added
    🐝 covered by PRHive verified that an open PR references or claims this issue; still actionable until confirmed
    on Oct 8, 2026
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

    documentationImprovements or additions to documentationqualityApproved by a Hive merger/owner for auto-merge on green CItestingApproved by a Hive merger/owner for auto-merge on green CI🐝 covered by PRHive verified that an open PR references or claims this issue; still actionable until confirmed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions