chore: add AGENTS.md - #2841
Conversation
📝 WalkthroughWalkthroughAdded Merge Risk: ⚪ Minimal · up to This PR only adds contributor guidance; one documented command typo is localized and creates no merge-blocking risk, so it is merge-ready after normal review. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Note
Quiet mode is enabled, so only the most important comments were posted inline. Other review comments are grouped below.
🟡 Other comments (1)
AGENTS.md-103-103 (1)
103-103: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winCorrect the
make manifeststarget name.Line 103 spells the target as
make manifets, so an agent following this instruction will run an invalid Make target. Use themake manifestsspelling documented on Line 48.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: QUIET
Plan: Enterprise
Run ID: 6c15eff0-7dfc-4010-819b-4af1243643bb
📒 Files selected for processing (1)
AGENTS.md
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
d167133 to
3cb8070
Compare
| - `cmd/` — binary entrypoints (operator manager and CLI tools). | ||
| - `deployments/gpu-operator/` — Helm chart for the operator. | ||
| - `assets/state-*` — per-operand manifests rendered by the `ClusterPolicy` state manager. | ||
| - `manifests/` — per-operand manifests rendered by the `GPUCluster` / `NVIDIADriver ` state managers. |
There was a problem hiding this comment.
nit:
| - `manifests/` — per-operand manifests rendered by the `GPUCluster` / `NVIDIADriver ` state managers. | |
| - `manifests/` — per-operand manifests rendered by the `GPUCluster` / `NVIDIADriver` state managers. |
| # AGENTS.md | ||
|
|
||
| Guidance for AI coding agents working in this repository. Human contributors should also read | ||
| [CONTRIBUTING.md](CONTRIBUTING.md) and the [documentation site](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/index.html) |
There was a problem hiding this comment.
nit: Trailing whitespace
There are quite a few in other lines as well (linenumbers: 24, 40, 56, 69, 72, 74, 76, 78, 84, 85, 103, 104)
| ## Testing Conventions | ||
|
|
||
| - Unit tests are co-located `*_test.go` files using `testify` (`require`/`assert`), typically table-driven | ||
| with a `map[string]struct{...}` of cases and `t.Run(name, ...)`. Run via `make unit-test`. New behavior |
There was a problem hiding this comment.
Instead of saying New behavior needs a unit test, could we say new Behavior needs appropriate test coverage. I was thinking maybe there are cases where integration tests or end to end tests make more sense than a unit test.
| ## Things to avoid | ||
|
|
||
| - Never commit credentials, API keys, tokens, passwords, kubeconfigs, or private keys. | ||
| - Do not hand-edit generated files. Run `make generate`/`make manifets` to regenerate deepcopy code and |
There was a problem hiding this comment.
| - Do not hand-edit generated files. Run `make generate`/`make manifets` to regenerate deepcopy code and | |
| - Do not hand-edit generated files. Run `make generate`/`make manifests` to regenerate deepcopy code and |
2 participants
Description
This PR adds an
AGENTS.mdfile to help AI coding agents contribute to the project. The overall structure of this file takes inspiration from existing projects, namely https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/AGENTS.md. We can definitely fine-tune this file over time.This addresses SIG-AGT-01, SIG-AGT-13, SIG-AGT-03, SIG-AGT-04, SIG-AGT-05, SIG-AGT-06, SIG-AGT-14, SIG-AGT-15, and SIG-AGT-16. from the OSS Scorecard.
Checklist
make lint)make validate-generated-assets)make validate-modules)Testing
OSS scorecard was run with and without this change.