[CLI-3864] Add AGENTS.md for cross-vendor agent guidance#3340
Open
Sajjad Lateef (sajjadlateef) wants to merge 2 commits intomainfrom
Open
[CLI-3864] Add AGENTS.md for cross-vendor agent guidance#3340Sajjad Lateef (sajjadlateef) wants to merge 2 commits intomainfrom
Sajjad Lateef (sajjadlateef) wants to merge 2 commits intomainfrom
Conversation
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
Sajjad Lateef (sajjadlateef)
requested a review
from Steven Gagniere (sgagniere)
Adds AGENTS.md following the agents.md open standard donated to the Linux Foundation in Dec 2025. Compatible with OpenAI Codex, GitHub Copilot, Cursor, Google Jules, Amp, Claude Code, and Aider. CLAUDE.md is a symlink to AGENTS.md so there is one source of truth. Also gitignores /.planning/ (local artifact directory). Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
airlock-confluentinc
Bot
force-pushed
the
add-AGENTS.md
branch
from
eac189b to
76edc62
Compare
Member
Steven Gagniere (sgagniere)
left a comment
Steven Gagniere (sgagniere)
left a comment
There was a problem hiding this comment.
Nice! I added some comments:
- Stack: drop the Go version literal (resists staleness) and Viper mention (Cobra is the framework callout). - Testing: drop the workflow:true bullet; integration-test rule now exempts purely global flags like -v / --unsafe-trace. - Compatibility: adding `omitempty` to a field that doesn't already have it is breaking — call it out explicitly. - Edit zones: scope "edit freely" to specific paths (pkg/ccloudv2, pkg/schemaregistry, pkg/cmd/flags.go) instead of all of pkg/; expand "don't touch" to include pkg/admin, pkg/auth, pkg/cmd, pkg/secret, pkg/config. Co-Authored-By: Claude Opus 4.7 (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
2 participants
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
AGENTS.md(139 lines, ~8.4 KB) following the agents.md open standard, donated to the Linux Foundation in Dec 2025. Compatible with OpenAI Codex, GitHub Copilot, Cursor, Google Jules, Amp, Claude Code, and Aider.CLAUDE.mdbecomes a symlink →AGENTS.mdso there is one source of truth (matches the pattern used in openai/codex, getcursor/cursor, and other major repos). Prevents drift between vendor-specific agent context files./.planning/to.gitignore(local artifact directory used by some agent tooling).The content reflects 2026 best practices (OpenAI Codex AGENTS.md guide, Augment Code 2026 guide): documents only non-inferable details (error/output formatting rules, Cobra annotation pattern for Cloud/On-Prem gating, multi-delete pattern, compatibility rules, ✅⚠️ 🚫 edit zones), with build/test commands placed early. Architecture and call-graph detail were intentionally cut — agents discover them from the code.
Jira: https://confluentinc.atlassian.net/browse/CLI-3864
Test plan
CLAUDE.mdsymlink resolves:cat CLAUDE.mdreturns the same content ascat AGENTS.md.git ls-files --stage CLAUDE.mdshows mode120000.pkg/cmd/ANNOTATIONS.md,pkg/cmd/AUTOCOMPLETION.md,pkg/errors/README.md,pkg/output/README.md,pkg/deletion/README.md,README.md,CONTRIBUTING.md.AGENTS.mdis picked up and used.make lint && make teststill pass on this branch (no code changes, but verifies the new files don't trip any lint rule).🤖 Generated with Claude Code