docs: clarify testing standards#6462
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes — prose clarifications across the testing-standards docs that recast tests as production code and require every test to make the guarantee it protects explicit through names, docstrings, table-case names, and fixture names.
- Tests as production code —
testing/index.mdx,anti-patterns.mdx, andcode-quality.mdxadd guidance that test code is reviewed and maintained with the same rigor as application code, with a guarantee-first docstring example. pkg/fuzzis mandatory for fuzz tests —fuzz-tests.mdxandanti-patterns.mdxnow requirefuzz.Seed(f),fuzz.New(t, data), and the consumer helpers instead of fuzzing typed parameters or usingmath/rand, plus the//pkg/fuzzBazel dependency.- Unexported symbols must be documented —
documentation.mdxextends the doc-comment rule to unexported functions/methods and changes the checklist item from "Every exported symbol" to "Every symbol". - Guarantee-first naming guidance —
unit-tests.mdx,http-handler-tests.mdx,integration-tests.mdx, andsimulation-tests.mdxadd examples and rules for naming tests, table cases, helpers, and fixtures after the production boundary they protect. - Tightened normative language — several "should not" / "should" statements become "must not" / "must" (e.g. refactors
must notbreak tests, unit testsmustbesmall).
I verified the load-bearing pkg/fuzz API claims against the source: fuzz.Seed (pkg/fuzz/seed.go:32), fuzz.New (pkg/fuzz/consumer.go:22), the Consumer type, c.String() (pkg/fuzz/get.go:78), and the t.Skip()-on-exhaustion behavior (pkg/fuzz/consumer.go:42-43). The fuzz example matches pkg/fuzz/doc.go, and the changes are internally consistent. Mergeable as-is.
Claude Opus | 𝕏

Summary
Verification
mise exec -- dprint check --config dev/dprint.json docs/engineering/contributing/quality; no MDX files matched the configured dprint plugins