Skip to content
This repository was archived by the owner on Aug 4, 2026. It is now read-only.

NO-ISSUE: Consolidate AI convention files into AGENTS.md - #294

Open
amir-yogev-gh wants to merge 2 commits into
osac-project:mainfrom
amir-yogev-gh:feat/ai-ready-agents-md
Open

NO-ISSUE: Consolidate AI convention files into AGENTS.md#294
amir-yogev-gh wants to merge 2 commits into
osac-project:mainfrom
amir-yogev-gh:feat/ai-ready-agents-md

Conversation

@amir-yogev-gh

Copy link
Copy Markdown

Summary

  • Fold .claude/rules/ content (controller patterns, common pitfalls, common tasks, configuration) into AGENTS.md for tool-agnostic access
  • Slim CLAUDE.md to @AGENTS.md (Claude auto-loads AGENTS.md via this reference)
  • Remove .claude/rules/ files (content now in AGENTS.md)
  • Add .github/copilot-instructions.md for GitHub Copilot support

Part of workspace-wide AI-readiness improvements (osac-workspace#60).

Assisted-by: Claude Code noreply@anthropic.com

Fold .claude/rules/ content (controller patterns, common pitfalls,
common tasks, configuration) into AGENTS.md so all AI tools can
access it. Slim CLAUDE.md to @AGENTS.md. Add Copilot instructions.

Assisted-by: Claude Code <noreply@anthropic.com>
Signed-off-by: Amir Yogev <ayogev@redhat.com>
@openshift-ci-robot

Copy link
Copy Markdown

@amir-yogev-gh: This pull request explicitly references no jira issue.

Details

In response to this:

Summary

  • Fold .claude/rules/ content (controller patterns, common pitfalls, common tasks, configuration) into AGENTS.md for tool-agnostic access
  • Slim CLAUDE.md to @AGENTS.md (Claude auto-loads AGENTS.md via this reference)
  • Remove .claude/rules/ files (content now in AGENTS.md)
  • Add .github/copilot-instructions.md for GitHub Copilot support

Part of workspace-wide AI-readiness improvements (osac-workspace#60).

Assisted-by: Claude Code noreply@anthropic.com

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci

openshift-ci Bot commented Jun 15, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: amir-yogev-gh
Once this PR has been reviewed and has the lgtm label, please assign jhernand for approval. 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

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@amir-yogev-gh, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 48 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: c3b80aa0-bbd5-423d-a7bb-b772ebe9b582

📥 Commits

Reviewing files that changed from the base of the PR and between acb50ad and 19a05e8.

📒 Files selected for processing (6)
  • .claude/rules/common-pitfalls.md
  • .claude/rules/common-tasks.md
  • .claude/rules/configuration.md
  • .claude/rules/controller-patterns.md
  • AGENTS.md
  • CLAUDE.md
✨ 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.

@openshift-ci

openshift-ci Bot commented Jun 15, 2026

Copy link
Copy Markdown

Hi @amir-yogev-gh. Thanks for your PR.

I'm waiting for a osac-project member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Assisted-by: Claude Code <noreply@anthropic.com>
Signed-off-by: Amir Yogev <ayogev@redhat.com>
Comment thread AGENTS.md
- **`common-pitfalls.md`** — 10 common issues: regen, status loops, finalizers, AAP polling, NotFound, etc.
- **`common-tasks.md`** — Adding CRDs/fields, cross-repo change order, RBAC, debugging
- **`configuration.md`** — Environment variables for AAP, gRPC, namespaces, controller flags
### Dual-Controller Pattern

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

AGENTS.md was intentionally kept minimal, with rules extracted to .claude/rules. Why revert that?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

CLAUDE.md is Claude specific. Using AGENTS.md file is a vendor agnostic approach.
You can still use CLAUDE.md just to reference AGENTS.md hence providing equal experience to other tools like Cursor and others.

@romfreiman

Copy link
Copy Markdown

Do we want to merge this one?

@sk-ilya

sk-ilya commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

I still don't understand why we need to grow agents.md from 132 lines to 320. It was intentionally kept minimal to avoid polluting the context with verbose rules that are not relevant most of the time. Those rules were kept in .claude/rules, with references from agents.md, and this PR effectively reverts that structure

@amir-yogev-gh

Copy link
Copy Markdown
Author

Everything under .claude/ is Claude specific. It's legit to break a long AGENTS.md into smaller files hence creating a progressive discloser.
BTW, putting a reference to .claude/ in AGENTS.md is abusing it, even though technically possible. Unless you want to provide Claude specific capabilities, you should put your content in vendor agnostic files referenced from AGENTS.md.

@amir-yogev-gh
amir-yogev-gh marked this pull request as ready for review June 29, 2026 10:35
@openshift-ci
openshift-ci Bot requested review from adriengentil and larsks June 29, 2026 10:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants