Add AGENTS.md for AI agent onboarding#613
Add AGENTS.md for AI agent onboarding#613RamLavi wants to merge 1 commit intok8snetworkplumbingwg:mainfrom
Conversation
Provides project structure, build/test commands, Go conventions, and development workflow context for AI coding agents. Assisted-by: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Ram Lavi <ralavi@redhat.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
gemini-code-assist you see how I take care of you? |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces AGENTS.md, a comprehensive documentation file for the kubemacpool project covering its architecture, directory structure, build processes, and development environment. A review comment identifies an incorrect Go version (1.25) listed in the Go conventions section, which needs to be corrected to a valid version.
| ## Go conventions | ||
|
|
||
| - **Module:** `github.com/k8snetworkplumbingwg/kubemacpool` | ||
| - **Go version:** 1.25 |
There was a problem hiding this comment.
The Go version 1.25 appears to be a typo, as Go 1.25 has not been released yet (current stable versions are 1.23 and 1.24). Please verify the correct Go version used in the project and update this line accordingly.
There was a problem hiding this comment.
what are you talking about? go1.24 is EOL IIRC https://go.dev/dl/
|
Thank you for the kind words! I'm glad to be of help. The |
|
@oshoval can you take a look? |
ormergi
left a comment
ormergi
left a comment
There was a problem hiding this comment.
Thanks for the PR, please see my comments
| automation/ CI script wrappers | ||
| ``` | ||
|
|
||
| ## Architecture |
| ### Pool manager | ||
|
|
||
| - Thread-safe MAC map tracking all allocated addresses | ||
| - Transaction support with configurable TTL (default 600s) for atomic allocation |
|
|
||
| No custom CRDs. Works with standard Kubernetes and KubeVirt types: | ||
| - **Pods** — MAC set via `k8s.v1.cni.cncf.io/networks` annotation | ||
| - **VirtualMachines** — MAC set in `domain.devices.interfaces[].macAddress` |
There was a problem hiding this comment.
Should we avoid API details? (or implementation details in general)
If so, how about "MAC adders specified in spec"
3 participants
What this PR does / why we need it:
This PR adds an AGENTS.md to the repo
This provides project structure, build/test commands, Go conventions, and development workflow context for AI coding agents.
Special notes for your reviewer:
Release note: