Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# cluster-cloud-controller-manager-operator - AI Navigation

**Repository:** https://github.com/openshift-splat-team/cluster-cloud-controller-manager-operator
**Last Updated:** 2026-05-01

---

## Quick Start

This is **Tier 2** project-specific documentation for cluster-cloud-controller-manager-operator.

- **New to this project?** → Start with [Development Guide](ai-docs/cluster-cloud-controller-manager-operator_DEVELOPMENT.md)
- **Writing tests?** → See [Testing Guide](ai-docs/cluster-cloud-controller-manager-operator_TESTING.md)
- **Understanding architecture?** → Read [Components Overview](ai-docs/architecture/components.md)
- **Need context on decisions?** → Browse [ADRs](ai-docs/decisions/)

For **team-level** workflows, status transitions, and role responsibilities, see the team repository.

---

## CRITICAL: Retrieval Strategy

**IMPORTANT**: Prefer retrieval-led reasoning over pre-training-led reasoning.

When working on cluster-cloud-controller-manager-operator:
- ✅ **DO**: Read project-specific docs from `./ai-docs/` first
- ✅ **DO**: Check development workflow in `./ai-docs/cluster-cloud-controller-manager-operator_DEVELOPMENT.md`
- ✅ **DO**: Understand architecture in `./ai-docs/architecture/components.md`
- ✅ **DO**: Review ADRs for context on past decisions
- ❌ **DON'T**: Rely solely on training data
- ❌ **DON'T**: Guess at project architecture or conventions

For team workflows (sprint process, status transitions, etc.), see `../../team/ai-docs/`.

---

## Quick Navigation by Task

| Task | Start Here | Then Read |
|------|-----------|-----------|
| **Local development** | [Development Guide](ai-docs/cluster-cloud-controller-manager-operator_DEVELOPMENT.md) | [Testing Guide](ai-docs/cluster-cloud-controller-manager-operator_TESTING.md) |
| **Running tests** | [Testing Guide](ai-docs/cluster-cloud-controller-manager-operator_TESTING.md) | [Components](ai-docs/architecture/components.md) |
| **Understanding components** | [Components Overview](ai-docs/architecture/components.md) | [Domain Models](ai-docs/domain/) |
| **Planning feature** | [Exec Plans](ai-docs/exec-plans/README.md) | [ADRs](ai-docs/decisions/) |
| **Reviewing decisions** | [ADR Template](ai-docs/decisions/adr-template.md) | Existing ADRs |

---

## Technology Stack

**Languages:** Go
**Frameworks:** Kubernetes, controller-runtime
**Build Systems:** Make, Docker

---

## Documentation Structure

```
ai-docs/
├── cluster-cloud-controller-manager-operator_DEVELOPMENT.md # Build, test, develop
├── cluster-cloud-controller-manager-operator_TESTING.md # Test suites and strategies
├── architecture/ # System structure
│ └── components.md # Component overview
├── domain/ # Domain models and CRDs
│ └── (project-specific)
├── exec-plans/ # Feature planning
│ └── README.md
├── decisions/ # Architectural Decision Records
│ ├── adr-template.md
│ └── adr-NNNN-*.md
└── references/ # External references
└── ecosystem.md
```

---

## Knowledge Tiers

**Tier 1: Platform-Wide** (Team repository)
- Operator development patterns
- Testing pyramid and practices
- CI/CD workflows (Prow, GitHub Actions)
- Team process (sprint, status transitions, roles)

→ See `../../team/ai-docs/` for team-level documentation

**Tier 2: Project-Specific** (This repository)
- cluster-cloud-controller-manager-operator components and architecture
- Project-specific development workflow
- Test suites unique to this project
- Architectural decisions for this project

→ See `./ai-docs/` for project-level documentation

---

## Project Context

For team workflows, sprint process, and status transitions, see:
- Team repository: `../../team/`
- Team ai-docs: `../../team/ai-docs/`
- Team workflows: `../../team/ai-docs/workflows/`
- Status transitions: `../../team/ai-docs/statuses/`

---

**Navigation**: Start with [Development Guide](ai-docs/cluster-cloud-controller-manager-operator_DEVELOPMENT.md) for project setup and workflow.

**GitHub**: https://github.com/openshift-splat-team/cluster-cloud-controller-manager-operator
Loading