Skip to content

docs: rename GEMINI.md to AGENTS.md with updated guidelines#2162

Open
cowsking wants to merge 1 commit into
GoogleContainerTools:mainfrom
cowsking:replace-gemini-with-agents
Open

docs: rename GEMINI.md to AGENTS.md with updated guidelines#2162
cowsking wants to merge 1 commit into
GoogleContainerTools:mainfrom
cowsking:replace-gemini-with-agents

Conversation

@cowsking
Copy link
Copy Markdown
Contributor

@cowsking cowsking commented May 15, 2026

  • Filename Standard: Renamed GEMINI.md to AGENTS.md (the standard name auto-discovered by most agent harnesses).
  • Repository Layout: Added a tabular map of the codebase so agents can locate components quickly without expensive directory traversals.
  • Progressive Disclosure: Streamlined the build/test commands to keep the file concise, pointing agents to docs/development.md and docs/testing.md as the sources of truth instead of duplicating setup details.
  • Skills Reference: Added a pointer to the .agents/ directory for any future repository-specific agent skills or automations.

@google-oss-prow
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from cowsking. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread AGENTS.md
Comment on lines +40 to +41
- `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`).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
- `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.

Comment thread AGENTS.md

## 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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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.

Comment thread AGENTS.md

## 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants