Document session learnings in CLAUDE.md - #290
Merged
Merged
Conversation
Records the go.mod go-directive dependency constraint, the two undocumented workflows (go-releaser.yml, zizmor.yml) and zizmor's common fix patterns, the solo-maintainer branch protection rationale, and the Snyk-vs-GitHub-native security tooling decision. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟡 Not ready to approve
Newly introduced proper-noun tokens in CLAUDE.md are likely to fail the repo’s Markdown spellcheck CI unless they’re backticked or added to the spellchecker wordlist.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR updates CLAUDE.md (the repository’s contributor/agent guidance) to capture recent operational learnings and clarify constraints that affect maintenance tasks and CI reliability.
Changes:
- Documents why
go.modusesgo 1.25.0(dependency/tidy constraint rather than stylistic preference). - Expands the GitHub Actions workflow documentation to include
go-releaser.yml,zizmor.yml, and branch protection/status-check rationale. - Adds a “Security Tooling” section recording the Snyk vs. GitHub-native tooling decision and verification guidance.
File summaries
| File | Description |
|---|---|
| CLAUDE.md | Adds maintenance/CI/security-tooling notes intended to prevent future “gotchas” (Go version directive, workflow pinning, branch protection, and security tooling decisions). |
Review details
Comments suppressed due to low confidence (2)
CLAUDE.md:128
- Several non-dictionary tokens here (e.g., zizmor/SARIF/artipacked/cache-poisoning/dependabot-cooldown) are not present in
.github/spellchecker-wordlist.txtand are likely to trip the Spellcheck Action. Consider rendering these as inline code (or add them to the wordlist in the same PR).
- **zizmor.yml** — static analysis for GitHub Actions workflow security
(script injection, credential persistence, cache poisoning); uploads SARIF
to code scanning. Common fixes: `persist-credentials: false` on
`actions/checkout` (artipacked), `cache: false` on `actions/setup-go` in
workflows that share a cache with untrusted PR builds (cache-poisoning),
CLAUDE.md:156
Snyk,CVE, and the plain-textzizmormention are not in.github/spellchecker-wordlist.txt; this may cause the Spellcheck Action to fail. Either add these words to the wordlist or format them as inline code.
- Snyk was evaluated and dropped (2026-07-30) in favor of GitHub-native
tooling — Dependabot alerts, secret scanning, and zizmor. If a
Snyk-sourced CVE is ever cited, verify the affected package actually
appears in `go.mod`/`go.sum` before treating it as relevant to this repo.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
CLAUDE.md now documents internal tooling terms (zizmor, artipacked, dependabot-cooldown, etc.) that aren't real dictionary words and don't belong in the project's public-facing wordlist. Also excludes docs/superpowers/**/*.md and .claude/**/*.md pre-emptively (the latter is already gitignored). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
go.mod'sgo 1.25.0directive is dependency-constrained (fatih/color/golang.org/x/sysrequire it), not a style choicego-releaser.ymlandzizmor.yml(plus zizmor's common fix patterns: artipacked, cache-poisoning, dependabot-cooldown)main's branch protection rationale (0 required approvals for solo maintainer, required status checks withstrict: true)go.mod/go.sumbefore being treated as relevantNo code changes — documentation only.