Skip to content

Add CLAUDE.md with project context for AI assistants#1845

Merged
openshift-merge-bot[bot] merged 1 commit into
rh-ecosystem-edge:mainfrom
TomerNewman:add-claude-md
Jul 6, 2026
Merged

Add CLAUDE.md with project context for AI assistants#1845
openshift-merge-bot[bot] merged 1 commit into
rh-ecosystem-edge:mainfrom
TomerNewman:add-claude-md

Conversation

@TomerNewman

@TomerNewman TomerNewman commented Jul 6, 2026

Copy link
Copy Markdown
Member

/cc @ybettan @yevgeny-shnaidman
/assign @ybettan @yevgeny-shnaidman

Summary by CodeRabbit

  • Documentation
    • Added a new project reference document with an overview of the operator, supported modes, and core architecture.
    • Included quick build and deployment commands, repository layout guidance, testing approach, and CI/CD conventions.
    • Listed generated files that should not be edited manually.

@netlify

netlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Deploy Preview for openshift-kmm ready!

Name Link
🔨 Latest commit 99f139e
🔍 Latest deploy log https://app.netlify.com/projects/openshift-kmm/deploys/6a4b65f61b75c10008a1baaf
😎 Deploy Preview https://deploy-preview-1845--openshift-kmm.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@openshift-ci

openshift-ci Bot commented Jul 6, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: TomerNewman

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

The pull request process is described 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

@openshift-ci openshift-ci Bot added the approved label Jul 6, 2026
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@TomerNewman, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a50988e8-6e67-40c3-9208-0f86f11f4649

📥 Commits

Reviewing files that changed from the base of the PR and between 9f66d86 and 99f139e.

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

Walkthrough

Adds a new CLAUDE.md documentation file describing the KMM operator's purpose, operating modes, build/deploy commands, repository code layout, architecture patterns, testing approach, and CI/CD conventions. No code or exported entity changes are included.

Changes

Project Documentation

Layer / File(s) Summary
Overview and quick reference
CLAUDE.md
Adds project title, operator description, spoke/hub operating modes, and quick-reference build/deploy commands.
Code layout and architecture
CLAUDE.md
Documents repository directory structure and core architecture/design patterns such as webhook separation, worker pods, and hub-spoke distribution.
Testing and CI/CD conventions
CLAUDE.md
Describes testing strategy, CI/CD conventions, and lists generated artifacts that must not be manually edited.

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

Suggested labels: documentation

Suggested reviewers: none identified

Poem

A rabbit hops through docs anew,
CLAUDE.md now guides the crew,
Modes of hub and spoke defined,
Commands and patterns neatly lined,
No code was touched, just words so true! 🐇📄

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the PR’s main change: adding CLAUDE.md as project context for AI assistants.
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.
✨ 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.

@yevgeny-shnaidman

Copy link
Copy Markdown
Member

/lgtm

@openshift-ci openshift-ci Bot added the lgtm label Jul 6, 2026
@TomerNewman

Copy link
Copy Markdown
Member Author

/retest

@openshift-merge-bot openshift-merge-bot Bot merged commit 5975fef into rh-ecosystem-edge:main Jul 6, 2026
21 checks passed
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.

3 participants