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]

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: 05c455c1-dd21-4257-8739-85ecbedecaef

📥 Commits

Reviewing files that changed from the base of the PR and between 2284caf and 22e2b72.

📒 Files selected for processing (4)

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

✅ Files skipped from review due to trivial changes (4)

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

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation

  • Added detailed agent instructions and repository guidelines covering development practices, design principles, and coding conventions
  • Enhanced project overview with comprehensive building, testing, and deployment instructions for developers

• Chores

  • Configured code review automation settings and tooling

Walkthrough

This PR adds repository scaffolding: AI agent guidelines, project documentation, and CodeRabbit review configuration. It introduces AGENTS.md, expands README.md with build/deploy instructions, and adds .coderabbit.yaml customizing review behavior and knowledge-base rules.

Changes

Repository Setup and Guidelines

Layer / File(s)	Summary
Repository Guidelines AGENTS.md	Adds agent instructions describing repo purpose (CVO-managed scaffolding-only OpenShift operator), expected layout (cmd/, pkg/, install/), design principles (multi-cloud via CloudProvider interfaces, CVO manifest/image-reference rules), operator/operand separation, and Go/coding conventions.
Project Documentation README.md	Adds project overview for karpenter-operator, build targets (make build, test, lint, verify, docker-build), dev deploy instructions (make deploy with configurable operator/operand images, cluster name, DEV flag), and links to AGENTS.md.
Review Tool Configuration .coderabbit.yaml	Creates .coderabbit.yaml enabling inheritance, sets en-US language, selects "chill" review profile, disables request_changes_workflow, enables high-level reporting (placeholders), disables sequence diagrams/effort estimation/poem output/suggested labels, enables auto-review with draft support, excludes vendor/**, enables golangci-lint, and configures a local-scoped knowledge base enforcing guidelines from AGENTS.md, .claude/agents/*.md, and .cursor/rules/*.mdc.

🚥 Pre-merge checks | ✅ 12

✅ Passed checks (12 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main changes: adding AGENTS.md and CodeRabbit configuration files, which are the primary focus of this PR.
Description check	✅ Passed	The description is directly related to the changeset, explaining what AGENTS.md contains, how .coderabbit.yaml configures automated reviews, and mentioning CLAUDE.md and README.md additions.
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	PR does not contain Ginkgo tests. Uses standard Go testing with t.Run(). All test names are stable, descriptive, and free of dynamic values. Check not applicable but technically compliant.
Test Structure And Quality	✅ Passed	The custom check targets Ginkgo test code, but this PR contains no Ginkgo tests. The codebase uses standard Go testing (testing package). Check is not applicable.
Microshift Test Compatibility	✅ Passed	No Ginkgo e2e tests were added in this PR. The PR adds only configuration and documentation files, not test code. Check not applicable.
Single Node Openshift (Sno) Test Compatibility	✅ Passed	No Ginkgo e2e tests are added in this PR. The PR contains only documentation, configuration files, and standard Go unit tests, not Ginkgo e2e tests. The SNO compatibility check does not apply.
Topology-Aware Scheduling Compatibility	✅ Passed	PR adds only configuration and documentation files. Does not modify deployment manifests, operator code, or controllers. Topology-aware scheduling check applies only when such artifacts are changed.
Ote Binary Stdout Contract	✅ Passed	PR contains only documentation and config changes (YAML, Markdown). No Go source files were modified. OTE stdout contract check only applies to process-level Go code changes.
Ipv6 And Disconnected Network Test Compatibility	✅ Passed	No Ginkgo e2e tests were added. Changes are configuration and documentation files only. IPv6/disconnected network test check is not applicable.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

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

[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/e2e-aws	22e2b72	link	true	/test e2e-aws

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.