-
Notifications
You must be signed in to change notification settings - Fork 235
feat: add AGENTS.md and CLAUDE.md #3149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
I'd rather we spend efforts on maintaining documentation for actual users than spending time having to maintain another document for "agents". |
Hi @metacosm , this is WIP, will probably change fundamentally. Those two are not solving the same problem, this is guidline for AI when writing / helping to write code. |
I know what this is for but this looks like documentation and, for all purposes and intents, it is. So that's yet another thing that would need to be updated when we already struggle with the "regular" documentation. |
|
|
||
| ### Integration Tests | ||
|
|
||
| - Use `LocallyRunOperatorExtension` or `OperatorExtension` from `operator-framework-junit5` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't stay true for much longer…
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, plan to do a facelift commit on next
|
@metacosm I did not have the time to get back on this properly yes, next week will do so. |
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds AI-agent-oriented repository guidance documentation to help automated coding tools work effectively within the Java Operator SDK repo.
Changes:
- Introduces
AGENTS.mdwith project structure, build/test commands, and coding conventions for agents. - Adds
CLAUDE.mdintended to point agents/tools at the primary guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
AGENTS.md |
New AI agents guide covering tooling, workflow, conventions, and patterns. |
CLAUDE.md |
New file intended as an entrypoint/reference to the agent guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Attila Mészáros a_meszaros@apple.com