Skip to content

Conversation

@csviri
Copy link
Collaborator

@csviri csviri commented Feb 3, 2026

Signed-off-by: Attila Mészáros a_meszaros@apple.com

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 3, 2026
@csviri csviri linked an issue Feb 3, 2026 that may be closed by this pull request
@csviri
Copy link
Collaborator Author

csviri commented Feb 3, 2026

@metacosm
Copy link
Collaborator

metacosm commented Feb 3, 2026

I'd rather we spend efforts on maintaining documentation for actual users than spending time having to maintain another document for "agents".

@csviri
Copy link
Collaborator Author

csviri commented Feb 3, 2026

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.

@csviri csviri changed the title feat: add AGENTS.md and CLAUDE.md [WIP] feat: add AGENTS.md and CLAUDE.md Feb 3, 2026
@metacosm
Copy link
Collaborator

metacosm commented Feb 3, 2026

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`
Copy link
Collaborator

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…

Copy link
Collaborator Author

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

@csviri
Copy link
Collaborator Author

csviri commented Feb 6, 2026

@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>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@csviri csviri requested a review from metacosm February 12, 2026 08:03
@csviri csviri marked this pull request as ready for review February 12, 2026 08:03
Copilot AI review requested due to automatic review settings February 12, 2026 08:03
@openshift-ci openshift-ci bot requested a review from xstefank February 12, 2026 08:03
@csviri csviri changed the title [WIP] feat: add AGENTS.md and CLAUDE.md feat: add AGENTS.md and CLAUDE.md Feb 12, 2026
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 12, 2026
@csviri
Copy link
Collaborator Author

csviri commented Feb 12, 2026

@metacosm @xstefank this is ready for review now, feel free to suggest improvements, I assume we will iterate on this in the future few times.

Copy link
Contributor

Copilot AI left a 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.md with project structure, build/test commands, and coding conventions for agents.
  • Adds CLAUDE.md intended 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.

csviri and others added 7 commits February 12, 2026 09:09
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Signed-off-by: Attila Mészáros <a_meszaros@apple.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>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@csviri csviri merged commit 21c735d into operator-framework:main Feb 13, 2026
24 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md

3 participants