[docs] Add AGENTS.md and CLAUDE.md for AI coding agent context#4809
[docs] Add AGENTS.md and CLAUDE.md for AI coding agent context#4809abiazett wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5ab0525365
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| make test # Unit tests (uses envtest for controller tests) | ||
|
|
||
| # Lint and format | ||
| make lint # golangci-lint (via ./scripts/lint.sh) |
There was a problem hiding this comment.
make lint instruction
This guide states that all commands run from ray-operator/, but it then instructs make lint, which is not a valid target there (ray-operator/Makefile has no lint: rule). Following this new instruction fails with No rule to make target 'lint', so agents and contributors using this file will immediately hit a dead-end on the documented lint workflow.
Useful? React with 👍 / 👎.
| golangci-lint run ./path/to/file.go | ||
|
|
||
| # Format a single file | ||
| gofumpt -w path/to/file.go |
There was a problem hiding this comment.
Add single-file test command
| ### Testing | ||
|
|
||
| - Unit tests use envtest for controller tests (simulated API server) | ||
| - E2E tests require a Kubernetes cluster (not run locally) |
There was a problem hiding this comment.
Can we add instruction for agents to create local Kind clusters for testing?
Future-Outlier
left a comment
Future-Outlier
left a comment
There was a problem hiding this comment.
I am thinking whether accept this PR or not, since most people can just feed DEVELOPER.md to claude code, codex, or gemini.
3 participants
Summary
Add
AGENTS.md(cross-tool AI agent context file) and aCLAUDE.mdsymlinkpointing to it, giving AI coding agents repo context: project layout,
build/test/lint commands, code generation workflow, and key conventions.
Why
AI coding agents (Claude Code, Codex, Cursor, GitHub Copilot, etc.) work more
effectively when they have a context file documenting repo structure and
commands. Without one, agents must rediscover the repo layout, build commands,
and conventions from scratch each session — leading to slower iteration,
incorrect commands, and style violations.
AGENTS.mdis the cross-tool convention (Codex, Cursor, etc.)CLAUDE.mdsymlink ensures Claude Code auto-discovers itWhat's included
The file documents (121 lines, under 150-line target):
ray-operator/is the primary componentmaketargets and where to run them fromTesting
markdownlint AGENTS.mdpassespre-commit run --files AGENTS.md CLAUDE.mdpassesCloses #4808