audit follow-up PR-A: documentation pass (14 findings)#16
Merged
oubiwann merged 1 commit intoMay 8, 2026
Merged
Conversation
Per docs/dev/0015-audit-follow-up-plan-address-all-16-findings.md. No behavioral changes; comment / doc / test-helper edits only. Findings closed: - F-1 cite AP-02 → AP-13 (pkg/golist/errors.go:16) - F-2 cite EH-08 → CC-08 + post-hoc-vs-propagation rationale (pkg/golist/golist.go:204-211) - F-3 cite EH-08 → CC-08 + same rationale (internal/cli/seam.go:62-69) - F-4 rationale strengthened in both classifier comments above (PR-C ctx-first refactor declined per work-order recommendation) - F-6 "Parallel-unsafe" header on each with*Seam test file (4 files) - F-7 cross-reference comment in cli_test.go:TestRun_Version pointing at version_test.withMetadata as the canonical pattern - F-8 inline writeAll into writeFile; delete helpers_test.go - F-9 inline-map subtest name → struct table in golist_test.go - F-10/F-11 changeset doc + internal comment rewritten to describe actual post-bug-#12 behaviour (filepath.Abs("") → cwd, not "stays empty") - F-12 PS-06 deviation note added to CLAUDE.md Architecture § (carry-forward to v1.0) - F-13 dead `_ = io.EOF` placeholder + comment removed - F-15 moduleRootSet config field doc-commented; flag stays - F-16 AP-07 deviation paragraph added at version.go var block (link-time vs runtime; kubectl/hugo/cobra precedent; no t.Parallel) - PROMPT-1 audit-prompt cite TD-09/IM-04 → IM-12/TD-09 in workbench/cc-audit-prompt-go-quality.md S-1 (citation drift): closed; all 3 concrete + 1 meta instance fixed. S-2 (seam-pattern discipline): closed at the doc layer; structural enforcement (vet linter) logged as v1.0+ future work. F-5, F-14 deferred to PR-B (cousin-shape symmetry). make check passes: build + lint (golangci-lint clean) + test (go test -race -count=1 ./...) all green.
4 tasks
5 tasks
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.
Summary
Closes 14 of 16 findings from PR #15's audit, plus the meta-finding
PROMPT-1. No behavioral changes — every edit is a comment, doc, test-helper, or test-table refactor that the substrate flagged.make check(build + lint viagolangci-lint+go test -race -count=1 ./...) passes against this branch.Per the disposition rows in
docs/dev/0015-audit-follow-up-plan-address-all-16-findings.md. Single commit per the plan's PR-A scope.Findings closed
(AP-02)cite for the string-match-Error rule(AP-13)atpkg/golist/errors.go:16EH-08cite for ctx-ordering ruleCC-08+ post-hoc-vs-propagation rationale atpkg/golist/golist.go:204-211internal/cli/seam.go:62-69t.Parallel()risk against package-level seamswithMetadatavs inline save/restore)cli_test.gointernal/cli/helpers_test.go's 8-linewriteAllwrapswriteFilegolist_test.go:106namefieldpkg/changeset/changeset.go:65-75changeset.go:113-118pkg/layout vs PS-06 SHOULD-AVOID_ = io.EOFplaceholder + commentpkg/golist/golist.gomoduleRootSetexists for test-driven designversion.go:54-71(link-time vs runtime; kubectl/hugo/cobra precedent; not.Parallel())TD-09 / IM-04mis-pairIM-12 / TD-09atworkbench/cc-audit-prompt-go-quality.mdS-1 (citation drift, 3 instances + meta): closed.
S-2 (seam pattern + no-
t.Parallel()discipline): closed at the doc layer; structural enforcement (custom vet linter) logged as v1.0+ future work.Diff scope
14 files modified, 1 deleted (
internal/cli/helpers_test.go); 120 insertions / 30 deletions. Plan estimated ~25 lines net change; the AP-07 / PS-06 / F-4 doc-strengthen paragraphs make the actual delta larger but still scope-clean.Test plan
make check(build + lint + test)helpers_test.gois gone andwriteFileworks (test passes)getCwd+filepath.Absflowgh pr view 15for the audit + CDC contextStacking
Base:
audit/0014-go-quality-audit(PR #15). After PR #15 merges, this PR's base can be retargeted tomain.PR-B (
audit/follow-up-pr-b-cousin-shape, closing F-5 + F-14) is parallel; not stacked on this branch.🤖 Generated with Claude Code