Skip to content

[ci] Add AGENTS.md and CLAUDE.md for AI agent guidance#3846

Open
rebtoor wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
rebtoor:agents
Open

[ci] Add AGENTS.md and CLAUDE.md for AI agent guidance#3846
rebtoor wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
rebtoor:agents

Conversation

@rebtoor
Copy link
Copy Markdown
Contributor

@rebtoor rebtoor commented Apr 13, 2026

Add structured documentation for AI coding agents working on this
repository. AGENTS.md provides repo-wide context: variable naming
rules, generated file warnings, testing commands, commit conventions,
and repository layout. CLAUDE.md adds Claude-specific behavioral
guidance and references AGENTS.md as the primary source of truth.

Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com

@rebtoor rebtoor requested a review from a team April 13, 2026 15:17
evallesp
evallesp previously approved these changes Apr 14, 2026
Copy link
Copy Markdown
Contributor

@evallesp evallesp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@michburk
Copy link
Copy Markdown
Contributor

After doing a bit of testing, it looks like claude code doesn't read AGENTS.md files at the start of a new session. I know quite a few people use claude code, so should we include a CLAUDE.md that is a symlink to AGENTS.md? Or maybe in CLAUDE.md just write something like "if you haven't already, read AGENTS.md" in case some tools load both AGENTS.md and CLAUDE.md? I'm not really sure if there is already some existing best approach for dealing with this.

Aside from that, a file like this is very useful, so thanks for making this!

@rebtoor
Copy link
Copy Markdown
Contributor Author

rebtoor commented Apr 17, 2026

After doing a bit of testing, it looks like claude code doesn't read AGENTS.md files at the start of a new session. I know quite a few people use claude code, so should we include a CLAUDE.md that is a symlink to AGENTS.md? Or maybe in CLAUDE.md just write something like "if you haven't already, read AGENTS.md" in case some tools load both AGENTS.md and CLAUDE.md? I'm not really sure if there is already some existing best approach for dealing with this.

Aside from that, a file like this is very useful, so thanks for making this!

It's a great idea! Let me address this issue then.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 17, 2026

New changes are detected. LGTM label has been removed.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 17, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from evallesp. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@rebtoor rebtoor changed the title [ci] Add AGENTS.md for AI coding agent guidance [ci] Add AGENTS.md and CLAUDE.md for AI agent guidance Apr 17, 2026
Comment thread AGENTS.md Outdated
@danpawlik
Copy link
Copy Markdown
Contributor

was it done by AI? I think that should be mentioned.

@softwarefactory-project-zuul
Copy link
Copy Markdown

Build failed (check pipeline). Post recheck (without leading slash)
to rerun all jobs. Make sure the failure cause has been resolved before
you rerun jobs.

https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/344b8264be824f9c8f75c7dcd0e70466

✔️ openstack-k8s-operators-content-provider SUCCESS in 1h 43m 32s
✔️ podified-multinode-edpm-deployment-crc SUCCESS in 1h 26m 21s
✔️ cifmw-crc-podified-edpm-baremetal SUCCESS in 1h 30m 54s
✔️ noop SUCCESS in 0s
✔️ cifmw-pod-ansible-test SUCCESS in 10m 04s
cifmw-pod-pre-commit TIMED_OUT in 31m 01s

@rebtoor
Copy link
Copy Markdown
Contributor Author

rebtoor commented Apr 17, 2026

was it done by AI? I think that should be mentioned.

Partly, but yes, i missed the "co-authored-by". Fixing rn.

Add structured documentation for AI coding agents working on this
repository. AGENTS.md provides repo-wide context: variable naming
rules, generated file warnings, testing commands, commit conventions,
and repository layout. CLAUDE.md adds Claude-specific behavioral
guidance and references AGENTS.md as the primary source of truth.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Roberto Alfieri <ralfieri@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants