Skip to content

OSAC-2402: add AGENTS.md for AI agent guidance - #18

Merged
amej merged 1 commit into
osac-project:mainfrom
amej:feat/OSAC-1962
Jul 20, 2026
Merged

OSAC-2402: add AGENTS.md for AI agent guidance#18
amej merged 1 commit into
osac-project:mainfrom
amej:feat/OSAC-1962

Conversation

@amej

@amej amej commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add AGENTS.md (125 lines) documenting the host-management-openstack operator for AI coding agents
  • Cover critical rules, dev environment commands, repository structure, architecture, CI, code quality, container security, code generation flow, test structure, and cross-component integration
  • Reference source-of-truth files (go.mod, Makefile, Containerfile, .golangci.yml) for versions instead of hardcoding patch-level values
  • Accurately describe make manifests as invoking controller-gen for RBAC, CRD, and webhook output while noting only RBAC is produced today (no local CRDs or webhooks)

Jira

https://redhat.atlassian.net/browse/OSAC-2402

Test plan

  • Every file path in AGENTS.md verified against the live repo
  • No patch-level version strings remain
  • Pre-commit hooks list matches .pre-commit-config.yaml
  • make manifests description aligns with Makefile target (lines 97-99)
  • Line count confirmed under 150-line ideal (125 lines)

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Added AGENTS.md with contributor rules, development commands, repository architecture, managed resources, code generation steps, testing expectations, CI references, security notes, and integration guidance.

Changes

Contributor Guidance

Layer / File(s) Summary
Repository development and architecture guidance
AGENTS.md
Documents contribution constraints, tooling and command checklists, repository structure, operator subsystems, code generation, testing, CI, security, and cross-component integration points.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 11
✅ Passed checks (11 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
No-Hardcoded-Secrets ✅ Passed AGENTS.md has no hardcoded credentials, tokens, passwords, private keys, base64 blobs, or URLs with embedded creds.
No-Weak-Crypto ✅ Passed PASS: AGENTS.md is documentation-only and contains no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB, custom crypto, or secret-comparison code.
No-Injection-Vectors ✅ Passed PR only changes AGENTS.md; no code paths or risky sinks like eval, yaml.load, shell=True, or innerHTML are present.
Container-Privileges ✅ Passed PASS: PR only adds AGENTS.md; no container/K8s manifests changed, and the doc mentions non-root runtime rather than privileged settings.
No-Sensitive-Data-In-Logs ✅ Passed AGENTS.md adds only docs; no log statements or examples expose secrets, PII, tokens, or host/customer data.
Ai-Attribution ✅ Passed HEAD commit includes Assisted-by: Claude Code <noreply@anthropic.com> and no Co-Authored-By trailer was found.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding AGENTS.md as guidance for AI agents.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@amej
amej force-pushed the feat/OSAC-1962 branch from de3d8d0 to 3acb9e2 Compare July 20, 2026 11:39
@amej amej changed the title OSAC-1962: add AGENTS.md for AI agent guidance OSAC-2402: add AGENTS.md for AI agent guidance Jul 20, 2026
@amej
amej force-pushed the feat/OSAC-1962 branch from 3acb9e2 to 9f3fb6a Compare July 20, 2026 11:53
@amej

amej commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.


Your plan includes PR reviews subject to rate limits. More reviews will be available in 20 minutes.

@amej

amej commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
✅ Action performed

Full review finished.

@amej amej changed the title OSAC-2402: add AGENTS.md for AI agent guidance OSAC-1962: sync AGENTS.md with codebase and condense to size limits Jul 20, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 25-26: Update the AGENTS.md descriptions for the make manifests
entries to accurately state that controller-gen generates RBAC, CRD, and webhook
manifests, while clarifying that this repository does not own the external
HostLease CRD. Apply the same correction to the referenced duplicate
documentation entries.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: osac-project/coderabbit/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 1d542e45-995f-4465-9cfc-a09849b09b78

📥 Commits

Reviewing files that changed from the base of the PR and between 5174020 and 9f3fb6a.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
…mits

Signed-off-by: Ameya Sathe <asathe@redhat.com>
Assisted-by: Claude Code <noreply@anthropic.com>
Signed-off-by: Ameya Sathe <asathe@redhat.com>

rh-pre-commit.version: 2.4.0
rh-pre-commit.check-secrets: ENABLED
@amej
amej force-pushed the feat/OSAC-1962 branch from 9f3fb6a to 4061ecd Compare July 20, 2026 13:01
@amej amej changed the title OSAC-1962: sync AGENTS.md with codebase and condense to size limits OSAC-2402: add AGENTS.md for AI agent guidance Jul 20, 2026
@amej
amej merged commit be1a972 into osac-project:main Jul 20, 2026
5 checks passed
@amej
amej deleted the feat/OSAC-1962 branch July 20, 2026 13:09
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.

1 participant