Skip to content

chore: add agent instructions and Go hook enforcement#8

Merged
cpcloud merged 4 commits into
mainfrom
codex/go-bestrules-agents-guide
Jun 2, 2026
Merged

chore: add agent instructions and Go hook enforcement#8
cpcloud merged 4 commits into
mainfrom
codex/go-bestrules-agents-guide

Conversation

@cpcloud
Copy link
Copy Markdown
Contributor

@cpcloud cpcloud commented Jun 2, 2026 •
edited
Loading

Summary

  • Add repo-level and scoped agent instruction files with matching CLAUDE.md symlinks.
  • Add Go-focused prek hooks for builtin hygiene, formatting, golangci-lint, testify helper checks, NilAway, and tests.
  • Add NilAway as a Go tool dependency and clean up existing lint/test findings so the hooks pass.

@cpcloud
docs: add agent instruction files
0791608 
Add repo-level and package-scoped agent guidance for Go practices, security-sensitive helpers, and test conventions. Add CLAUDE.md symlinks beside each AGENTS.md so tools that read either name get the same instructions.
@roborev-ci
Copy link
Copy Markdown

roborev-ci Bot commented Jun 2, 2026

roborev: Combined Review (0791608)

Medium issue found: CLAUDE.md symlink aliases may break instruction loading on Windows checkouts.

Medium

  • Location: CLAUDE.md:1
  • Problem: The CLAUDE.md files are Git symlinks to AGENTS.md. On common Windows checkouts without symlink support, these can materialize as plain files containing only AGENTS.md, so Claude-style tools may not receive the intended instructions despite the repo supporting Windows workflows.
  • Fix: Make the CLAUDE.md files real Markdown files, either duplicating the content or using a tool-supported include/reference mechanism that works on Windows.

Panel: ci_default_security | Synthesis: codex, 6s | Members: codex_default (codex/default, done, 2m16s), codex_security (codex/security, done, 9s) | Total: 2m31s | Job: 19669

@cpcloud
docs: keep root agent guidance intent focused
af662ca 
Remove the top-level command recipe and defer exact verification commands to CI, go.mod, and tool config. Keep lint guidance tied to the configured style contract instead of repeating concrete linter settings.
@roborev-ci
Copy link
Copy Markdown

roborev-ci Bot commented Jun 2, 2026

roborev: Combined Review (af662ca)

No issues found.

Synthesized from 2 reviews (agents: codex | types: default, security)

Panel: ci_default_security | Synthesis: codex | Members: codex_default (codex/default, done, 13s), codex_security (codex/security, done, 13s) | Total: 26s | Job: 19687

cpcloud added 2 commits June 2, 2026 10:37
@cpcloud
docs: avoid duplicating hook-enforced guidance
de951f6 
Remove top-level formatter, lint, and verification-command prose that belongs in hook or tool configuration. Keep the root agent file focused on intent and package-level behavior.
@cpcloud
chore: add Go hook enforcement
5713a69 
Add prek hooks for builtin hygiene, Go formatting, golangci-lint, testify helper enforcement, NilAway, and Go tests. Add NilAway as a Go tool dependency and clean up existing lint/test findings so the new hooks pass.
@cpcloud cpcloud changed the title docs: add agent instruction files chore: add agent instructions and Go hook enforcement Jun 2, 2026
@roborev-ci
Copy link
Copy Markdown

roborev-ci Bot commented Jun 2, 2026

roborev: Combined Review (5713a69)

No issues found.

Synthesized from 2 reviews (agents: codex | types: default, security)

Panel: ci_default_security | Synthesis: codex | Members: codex_default (codex/default, done, 3m33s), codex_security (codex/security, done, 2m42s) | Total: 6m15s | Job: 19726

@cpcloud cpcloud merged commit 24a948b into main Jun 2, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mariusvniekerk mariusvniekerk mariusvniekerk approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cpcloud @mariusvniekerk