You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
🤖 fix: refresh AGENTS.md to match current repo (#16)
## Summary
Refresh `AGENTS.md` so it accurately documents the current `coder-k8s`
architecture, tooling, commands, and contribution workflow.
## Background
`AGENTS.md` had drifted from the repository state (Go version,
architecture scope, command set, and key paths). This update aligns
contributor/agent guidance with the actual codebase to reduce onboarding
and execution errors.
## Implementation
- Updated project overview to describe both app modes (`controller` and
`aggregated-apiserver`).
- Corrected tech stack details (Go `1.25.7`, inclusion of `apiserver`,
`golangci-lint`/`gofumpt`, and `scripts/`).
- Expanded key files and important directories to include:
- dispatch/bootstrap packages (`app_dispatch.go`, `internal/app/...`)
- aggregated API types/storage (`api/aggregation/...`,
`internal/aggregated/...`)
- manifest/deploy/release/lint assets (`config/`, `deploy/`,
`.golangci.yml`, `.goreleaser.yaml`, `Dockerfile.goreleaser`,
`release.yaml`)
- Updated architecture notes for required `--app` dispatch and
aggregated API installation.
- Refreshed essential commands to match Makefile/linting workflow (`make
lint`, `make manifests`, `make vuln`, mode-specific run commands,
`golangci-lint fmt`).
- Updated patterns/checklists to include generated-manifest flow and
broader test expectations.
- Added Uber Go style guide as baseline guidance while preserving
project-specific conventions.
## Validation
- `make verify-vendor`
- `make test`
- `make build`
- `make lint`
## Risks
Low risk (documentation-only). Main regression risk is stale guidance
over time; this change reduces that by aligning docs with current
repository structure.
---
_Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking:
`xhigh` • Cost: `$0.34`_
<!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh
costs=0.34 -->
Copy file name to clipboardExpand all lines: AGENTS.md
+50-28Lines changed: 50 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,51 +2,71 @@ You are an experienced, pragmatic software engineering AI agent. Do not over-eng
2
2
3
3
## Project Overview
4
4
5
-
`coder-k8s` is a Go-based Kubernetes operator scaffold for managing a custom resource named`CoderControlPlane` (`coder.com/v1alpha1`). The current codebase focuses on baseline wiring: CRD types, scheme registration, controller startup, and a placeholder reconciliation loop.
5
+
`coder-k8s` is a Go-based Kubernetes control-plane project with two app modes: a controller-runtime operator for`CoderControlPlane` (`coder.com/v1alpha1`) and an aggregated API server for `CoderWorkspace`/`CoderTemplate` (`aggregation.coder.com/v1alpha1`).
-**Do** keep controller and API changes paired with tests in `main_test.go` or focused package tests.
61
-
**Don’t** add reconciliation behavior without coverage for critical assumptions.
78
+
-**Do** regenerate generated artifacts after API changes (`make codegen`, `make manifests`).
79
+
**Don’t** hand-edit generated files like `zz_generated.deepcopy.go` or CRD/RBAC manifests.
80
+
-**Do** keep controller, aggregated API server, and storage changes paired with focused tests (`main_test.go`, `internal/controller/*_test.go`, and package tests under `internal/app/`/`internal/aggregated/`).
81
+
**Don’t** add behavior without coverage for critical assumptions.
62
82
63
83
## Anti-patterns
64
84
@@ -68,7 +88,8 @@ Run from repository root.
68
88
69
89
## Code Style
70
90
71
-
- Follow idiomatic Go and keep code `gofmt`-formatted.
91
+
- Follow idiomatic Go and the [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) as a baseline; project-specific rules in this file take precedence.
92
+
- Keep code `gofumpt`-formatted (enforced via `golangci-lint fmt`).
0 commit comments