chore(agent): add AGENTS.md and CLAUDE.md (symlink)#6
Conversation
Co-Authored-By: Claude Code (Claude Sonnet 4.5) <noreply@anthropic.com> Signed-off-by: Philippe Martin <phmartin@redhat.com>
📝 WalkthroughWalkthroughAdds new top-level documentation files describing AI agent usage and guidance for the repository, including project overview, CLI/skills architecture, command/skill creation, testing, and conventions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
AGENTS.md (1)
72-72: Avoid hardcoding the calendar year in evergreen guidance.Line 72 (“The current year is 2026.”) will age quickly; prefer neutral wording or referencing a maintained source.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 72, Replace the hardcoded sentence "The current year is 2026." in AGENTS.md with neutral wording or a reference to a maintained source (e.g., "the current year" or "see the /copyright-headers skill for the current year") so the guidance stays evergreen; locate the exact line containing "The current year is 2026." and update it to avoid embedding a calendar year.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@AGENTS.md`:
- Line 72: Replace the hardcoded sentence "The current year is 2026." in
AGENTS.md with neutral wording or a reference to a maintained source (e.g., "the
current year" or "see the /copyright-headers skill for the current year") so the
guidance stays evergreen; locate the exact line containing "The current year is
2026." and update it to avoid embedding a calendar year.
AGENTS.md
Outdated
| ## Dependencies | ||
|
|
||
| - Cobra (github.com/spf13/cobra): CLI framework | ||
| - Go 1.25.7 |
There was a problem hiding this comment.
I think in other files, we try to keep at the end a + to says 'this version and the upcoming one' so we don't stick to a given one
There was a problem hiding this comment.
side note: why for example not use go 1.26.0 (the latest one)
There was a problem hiding this comment.
side note: why for example not use go 1.26.0 (the latest one)
I'm happy not using a too much recent version, I'll update ASAP
| # Check code coverage | ||
| go test -cover ./... | ||
| ``` | ||
|
|
There was a problem hiding this comment.
something about formatter / go fmt to format ?
Co-Authored-By: Claude Code (Claude Sonnet 4.5) <noreply@anthropic.com> Signed-off-by: Philippe Martin <phmartin@redhat.com>
There was a problem hiding this comment.
♻️ Duplicate comments (1)
AGENTS.md (1)
92-94:⚠️ Potential issue | 🟡 MinorKeep Go version guidance synchronized with
go.mod/toolchain.
Go 1.25+in docs can drift from the enforced project version. Consider documenting the exact baseline fromgo.mod(and optionally the tested max range) to avoid contributor mismatch.#!/bin/bash # Verify documented Go version vs repository source of truth. # Expected: AGENTS.md version guidance should match go.mod/toolchain directive. set -euo pipefail echo "== go.mod locations ==" fd '^go\.mod$' -a echo echo "== go.mod headers (first 40 lines) ==" fd '^go\.mod$' -x sh -c 'echo "--- $1 ---"; sed -n "1,40p" "$1"' sh {} echo echo "== Version mentions in docs ==" rg -n 'Go\s+[0-9]+\.[0-9]+(\+)?|toolchain\s+go[0-9]+\.[0-9]+' AGENTS.md README.md🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 92 - 94, AGENTS.md currently lists "Go 1.25+" which can drift from the repository source of truth; update the Go version guidance in AGENTS.md to match the exact module/toolchain version declared in go.mod (and/or the toolchain directive in go.work if present) — replace the "Go 1.25+" text with the exact version string found in go.mod (e.g., the module's go directive) and optionally add a tested range note (e.g., "tested with Go X.Y and above") to keep docs and the project toolchain in sync.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@AGENTS.md`:
- Around line 92-94: AGENTS.md currently lists "Go 1.25+" which can drift from
the repository source of truth; update the Go version guidance in AGENTS.md to
match the exact module/toolchain version declared in go.mod (and/or the
toolchain directive in go.work if present) — replace the "Go 1.25+" text with
the exact version string found in go.mod (e.g., the module's go directive) and
optionally add a tested range note (e.g., "tested with Go X.Y and above") to
keep docs and the project toolchain in sync.
2 participants
Add an AGENTS.md file (generated with /init skill and a few changes), and a CLAUDE.md symlinking to it