docs: rename GEMINI.md to AGENTS.md with updated guidelines#2162
docs: rename GEMINI.md to AGENTS.md with updated guidelines#2162cowsking wants to merge 1 commit into
Conversation
|
[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 |
There was a problem hiding this comment.
Code Review
This pull request replaces the Config Sync GEMINI.md file with a new AGENTS.md file, which provides structured guidance for AI coding agents. The new documentation includes a project summary, repository layout, and build/test instructions. Review feedback suggests clarifying the scope of the make test command to include linting and kustomization, adding the make fmt-go command for code style compliance, and ensuring the file ends with a trailing newline for Unix compatibility.
| - `make test` — Runs fast Go unit tests. | ||
| - `make test-e2e-kind` — Runs end-to-end validation against a local kind cluster (requires pre-installing kind via `make install-kind`). |
There was a problem hiding this comment.
The description for make test has been updated to accurately reflect that it includes linting and kustomization tests as defined in the Makefile (line 394). Additionally, make fmt-go is included in the list as it is a critical step for ensuring code style compliance before submission.
| - `make test` — Runs fast Go unit tests. | |
| - `make test-e2e-kind` — Runs end-to-end validation against a local kind cluster (requires pre-installing kind via `make install-kind`). | |
| - `make test` — Runs unit tests, kustomization tests, and linting. | |
| - `make test-e2e-kind` — Runs end-to-end validation against a local kind cluster (requires pre-installing kind via `make install-kind`). | |
| - `make fmt-go` — Formats Go code using gofmt and goimports. |
|
|
||
| ## Agent Skills | ||
|
|
||
| Shared agent skills and custom automations for working in this repository should be organized within an `.agents/` directory following emerging repository standards. No newline at end of file |
There was a problem hiding this comment.
The file is missing a newline at the end. It is a standard practice to end text files with a newline to ensure compatibility with various Unix tools and to avoid issues with diffs.
| Shared agent skills and custom automations for working in this repository should be organized within an `.agents/` directory following emerging repository standards. | |
| Shared agent skills and custom automations for working in this repository should be organized within an .agents/ directory following emerging repository standards. | |
|
|
||
| ## Build, test, lint | ||
|
|
||
| All primary build and testing workflows run through the [Makefile](Makefile). Prefer using `make` targets over invoking native tools directly to maintain consistency with CI. |
There was a problem hiding this comment.
Not seeing the dependency bump rules described, I guess the agent is only counting in the build/test rules for now, not our customized maintenance logics. Is it now an option to deploy agents in the repo and help us bump the deps like Helm? It would be super nice to see a sample of that.
Uh oh!
There was an error while loading. Please reload this page.