docs: sync for v3.3.0.4 — suite counts, test-helper contract, roadmap - #67
Merged
Conversation
Four releases shipped since the last doc pass and the counts went stale. - CLAUDE.md / AGENTS.md / CONTRIBUTING all said "eight suites". There are ten runnable suites now; test-doctor.sh and test-status.sh landed in v3.3.0.4. CLAUDE.md also still claimed smoke-test was 371 assertions; it is 393. - Documented test/test-helper.sh, which is the one genuinely new contributor contract in this range. It is sourced rather than run, so listing it as an eleventh suite would have been wrong — called out explicitly, along with the rule that a suite must not define its own counters (smoke-test fails on one, and a mutation proves that guard works). - CONTRIBUTING gained a "Writing a new assertion" section: check() now takes an optional expected exit code and output regex, which nothing documented, and the two suites keeping a differently-shaped wrapper (check_version, check_listing) needed saying so nobody re-adds a third variant. - ROADMAP still led with v3.3.0.0 and read present-tense about eight suites in CI. Added the v3.3.0.1-v3.3.0.4 roundup covering the two fixes a user would notice (skills naming commands that don't exist; apostrophe search returning a wrong-typed record), and scoped the CI claim to "eight at v3.3.0.0, ten today". - TODOS.md now points at the three open issues from the PR triage. CONTRIBUTING called TODOS.md "the backlog" while #60-#62 lived only on GitHub. The pointer links them without copying, so the issue stays authoritative. CHANGELOG left alone: its "eight suites" line is inside the v3.3.0.0 entry and was true at that release. VERSION unchanged at 3.3.0.4 — docs-only, nothing here to ship. Verified: gen-skills --dry-run clean (22 templates), smoke 393/393, integration 48/48, doctor 13/13, status 22/22. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Post-ship doc pass covering v3.3.0.1 through v3.3.0.4. No code changes.
What was stale
Three docs said "eight suites"; there are ten runnable ones now (
test-doctor.shandtest-status.shlanded in v3.3.0.4). CLAUDE.md also still claimed smoke-test was 371 assertions — it's 393.What was undocumented
test/test-helper.shis the one genuinely new contributor contract in this range and nothing described it. It's sourced, not run, so listing it as an eleventh suite would have been wrong — called out explicitly, along with the rule that a suite must not define its own counters (smoke-test fails on one, and a mutation proves that guard works).CONTRIBUTING gained a "Writing a new assertion" section:
check()now takes an optional expected exit code and output regex, which nothing documented, and the two suites keeping a differently-shaped wrapper (check_version,check_listing) needed saying so nobody adds a third variant.Narrative
CHANGELOG left alone — its "eight suites" line sits inside the v3.3.0.0 entry and was true at that release.
Verification
Every numeric claim re-derived by running the thing, not by reading:
Also checked every
test/,bin/,templates/,docs/path referenced in the docs resolves to a real file.VERSION unchanged at 3.3.0.4 — docs-only, nothing here to ship.
Note: the usual cross-model doc review didn't run.
codexis installed but its vendored binary is missing (ENOENToncodex-darwin-arm64/.../codex), so it fails to spawn. Worth anpm i -g @openai/codexreinstall before the next review-dependent run.🤖 Generated with Claude Code