Skip to content

docs: clarify testing standards#6462

Merged
chronark merged 1 commit into
mainfrom
chronark/docs-quality-testing-standards
Jun 16, 2026
Merged

docs: clarify testing standards#6462
chronark merged 1 commit into
mainfrom
chronark/docs-quality-testing-standards

Conversation

@chronark

Copy link
Copy Markdown
Collaborator

Summary

  • clarify that tests should document the guarantee they protect
  • add guidance for test names, docstrings, helpers, fixtures, and handler authorization checks
  • document the expected pkg/fuzz pattern for fuzz tests

Verification

  • Reviewed staged docs diff
  • Attempted mise exec -- dprint check --config dev/dprint.json docs/engineering/contributing/quality; no MDX files matched the configured dprint plugins

@mintlify

mintlify Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
engineering 🟢 Ready View Preview Jun 16, 2026, 7:11 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@vercel

vercel Bot commented Jun 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
dashboard Ready Ready Preview, Comment Jun 16, 2026 7:12am
design Ready Ready Preview, Comment Jun 16, 2026 7:12am

Request Review

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ 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 codetesting/index.mdx, anti-patterns.mdx, and code-quality.mdx add guidance that test code is reviewed and maintained with the same rigor as application code, with a guarantee-first docstring example.
  • pkg/fuzz is mandatory for fuzz testsfuzz-tests.mdx and anti-patterns.mdx now require fuzz.Seed(f), fuzz.New(t, data), and the consumer helpers instead of fuzzing typed parameters or using math/rand, plus the //pkg/fuzz Bazel dependency.
  • Unexported symbols must be documenteddocumentation.mdx extends the doc-comment rule to unexported functions/methods and changes the checklist item from "Every exported symbol" to "Every symbol".
  • Guarantee-first naming guidanceunit-tests.mdx, http-handler-tests.mdx, integration-tests.mdx, and simulation-tests.mdx add 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 not break tests, unit tests must be small).

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.

Pullfrog  | View workflow run | Using Claude Opus𝕏

@chronark chronark merged commit 4ea6b46 into main Jun 16, 2026
16 of 17 checks passed
@chronark chronark deleted the chronark/docs-quality-testing-standards branch June 16, 2026 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant