[ci] Add AGENTS.md and CLAUDE.md for AI agent guidance#3846
[ci] Add AGENTS.md and CLAUDE.md for AI agent guidance#3846rebtoor wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
Conversation
|
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. |
|
New changes are detected. LGTM label has been removed. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
rebtoor
changed the title
|
was it done by AI? I think that should be mentioned. |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/344b8264be824f9c8f75c7dcd0e70466 ✔️ openstack-k8s-operators-content-provider SUCCESS in 1h 43m 32s |
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>
| ## Claude-specific guidance | ||
|
|
||
| ### Before committing | ||
|
|
||
| Run `pre-commit run --all-files` to validate changes before suggesting a commit. | ||
|
|
||
| ### Validation priority | ||
|
|
||
| When asked to verify a change, run checks in this order: | ||
|
|
||
| 1. `pre-commit run --all-files` — fast lint pass (ansible-lint, black, shellcheck). | ||
| 2. `TEST_SINGLE_ROLE=<role> make molecule` — targeted Molecule test. | ||
| 3. `make ansible_test` — plugin unit/sanity/integration tests (only if plugins changed). | ||
| 4. `make docs` — only if documentation was modified. | ||
|
|
||
| ### macOS limitations | ||
|
|
||
| The Makefile test targets (`make tests`, `make molecule`, `make ansible_test`, | ||
| `make setup_tests`, `make setup_molecule`, and their `_nodeps` variants) **do not | ||
| work on macOS**. The underlying scripts use `readlink -f`, which is not available | ||
| on macOS. These targets are designed for Linux CI environments only. |
There was a problem hiding this comment.
[non-blocking] question: Is this info claude-code specific? Or could it also live in the agents.md file?
|
The |
4 participants
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