AUTOSCALE-584: add AGENTS.md and CodeRabbit config

[maxcao13]

AGENTS.md defines design principles (multi-cloud boundaries, CVO manifest rules, operator/operand separation), coding conventions, and the planned architecture direction.

.coderabbit.yaml configures automated PR reviews with AGENTS.md as the knowledge base source, vendor exclusion, and golangci-lint.

Also adds a CLAUDE.md which points to AGENTS.md and a simple README.md.

[openshift-ci-robot]

@maxcao13: This pull request references AUTOSCALE-584 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

AGENTS.md defines design principles (multi-cloud boundaries, CVO manifest rules, operator/operand separation), coding conventions, and the planned architecture direction.

.coderabbit.yaml configures automated PR reviews with AGENTS.md as the knowledge base source, vendor exclusion, and golangci-lint.

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]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maxcao13

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:

• OWNERS [maxcao13]

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

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: f13a630a-5651-4b1a-8a1d-b04a75051111

📥 Commits

Reviewing files that changed from the base of the PR and between af8a3a6 and 5331de3.

📒 Files selected for processing (4)

• .coderabbit.yaml
• AGENTS.md
• CLAUDE.md
• README.md

🚧 Files skipped from review as they are similar to previous changes (4)

• .coderabbit.yaml
• CLAUDE.md
• AGENTS.md
• README.md

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation

  • Added contributor “Agent Instructions” covering multi-cloud coding rules, operator vs. operand responsibilities, and recommended development/lint/verify workflow
  • Updated the project README with a clearer operator overview plus build and dev deployment instructions, and linked to the agent guidance
  • Updated contributor guidance references for CLAUDE to point to the shared instructions

• Chores

  • Updated repository automation and review settings (language default, summaries, walkthrough behavior, file-change summaries, draft-friendly auto-review, and path filtering)
  • Enabled golangci-lint tooling and added a local knowledge base for guideline enforcement

Walkthrough

Adds repository scaffolding: CodeRabbit review configuration, contributor agent guidelines, project documentation, and a CLAUDE.md reference to AGENTS.md.

Changes

Repository Setup and Contributor Guidance

Layer / File(s)	Summary
Review configuration .coderabbit.yaml	Configures review language, profile, automation, path filters, summaries, tooling, and knowledge-base guidance sources.
Contributor and agent guidance AGENTS.md, CLAUDE.md	Documents multi-cloud development constraints, operator and operand responsibilities, validation workflows, and references AGENTS.md from CLAUDE.md.
Project documentation README.md	Adds the operator overview, build and validation targets, development deployment instructions, configurable image and cluster parameters, and contributor guidance link.

🚥 Pre-merge checks | ✅ 15

✅ Passed checks (15 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly matches the main change: adding AGENTS.md and CodeRabbit configuration.
Description check	✅ Passed	The description is directly related to the changeset and summarizes the added docs and review config.
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.
Stable And Deterministic Test Names	✅ Passed	Diff touches only docs/config files; no Ginkgo test titles were added or modified.
Test Structure And Quality	✅ Passed	No Ginkgo test files were changed; the PR only adds docs/config, so the test-quality check is not applicable.
Microshift Test Compatibility	✅ Passed	Only docs/config files changed; no Ginkgo e2e tests or test code were added, so MicroShift compatibility is not applicable.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	No new Ginkgo e2e tests were added; the PR only changes docs/config files, so SNO compatibility is not applicable.
Topology-Aware Scheduling Compatibility	✅ Passed	Only docs/config files changed (.coderabbit.yaml, AGENTS.md, CLAUDE.md, README.md); no manifests, controllers, or scheduling code were modified.
Ote Binary Stdout Contract	✅ Passed	PR changes only docs/config (.coderabbit.yaml, AGENTS.md, CLAUDE.md, README.md); no process-level code or stdout writes were added.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	PR only adds docs/config files (AGENTS, README, CLAUDE, .coderabbit); no Ginkgo e2e tests or network/IP-sensitive code was added.
No-Weak-Crypto	✅ Passed	Touched files are docs/config only; no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB, custom crypto, or secret-comparison code found.
Container-Privileges	✅ Passed	PR only changes docs/config; no container manifests or securityContext fields like privileged, hostPID, hostNetwork, or allowPrivilegeEscalation were added.
No-Sensitive-Data-In-Logs	✅ Passed	Only docs/config files changed; no log statements or secret/PII-like values were added.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[maxcao13]

/test verify

[openshift-ci]

@maxcao13: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/verify	5331de3	link	true	/test verify

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.