Remove deterministic docs wording tests and tighten test guidance #134

Closed
opened 2026-05-07 11:44:28 -07:00 by jwilger · 0 comments
Owner

Follow-up from PR #133 review.

Problem

Deterministic tests that assert documentation wording are low-value and have started to encode docs-only changes as Rust test contracts. Tests should cover production behavior and essential developer tooling, not prose.

Scope

  • Inventory existing tests that include or assert operator/user docs wording.
  • Remove tests whose only purpose is checking documentation language.
  • Keep tests that protect executable behavior, generated docs, public CLI contracts, schemas, deployment artifacts, or other machine-consumed contracts.
  • Convert any ambiguous cases into production behavior tests or manual docs-review guidance.
  • Ensure project guidance prevents adding docs-only wording tests in the future.

Acceptance criteria

  • No test remains whose sole assertion is deterministic documentation wording for docs-only content.
  • Legitimate executable/public-surface contract tests are explicitly justified near the test or in contributor guidance.
  • RGR/TDD guidance continues to exempt docs-only changes from RED and directs agents to use human/operator review for prose changes.

Origin: jwilger/auto_review#133 (comment)

Follow-up from PR #133 review. ## Problem Deterministic tests that assert documentation wording are low-value and have started to encode docs-only changes as Rust test contracts. Tests should cover production behavior and essential developer tooling, not prose. ## Scope - Inventory existing tests that include or assert operator/user docs wording. - Remove tests whose only purpose is checking documentation language. - Keep tests that protect executable behavior, generated docs, public CLI contracts, schemas, deployment artifacts, or other machine-consumed contracts. - Convert any ambiguous cases into production behavior tests or manual docs-review guidance. - Ensure project guidance prevents adding docs-only wording tests in the future. ## Acceptance criteria - No test remains whose sole assertion is deterministic documentation wording for docs-only content. - Legitimate executable/public-surface contract tests are explicitly justified near the test or in contributor guidance. - RGR/TDD guidance continues to exempt docs-only changes from RED and directs agents to use human/operator review for prose changes. Origin: https://git.johnwilger.com/jwilger/auto_review/pulls/133#issuecomment-3542
jwilger added this to the (deleted) project 2026-05-10 07:35:54 -07:00
jwilger added this to the 1.0 milestone 2026-05-10 07:44:56 -07:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Slipstream/auto_review#134
No description provided.