docs: add AGENTS.md for AI contributors#989
Conversation
Add an AGENTS.md quick-reference covering project layout, development commands, template workflow, code style, and agent-specific contribution tips.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
![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 quick-reference guide for AI and human contributors to the Agent Starter Pack. The feedback suggests correcting the path to the Go templates to use the full repository path agent_starter_pack/base_templates/go/ instead of the relative one to avoid confusion.
| ## Code Style | ||
|
|
||
| - Python: `ruff` (line length 88, target `py311`), `ty` type checker, `codespell`. | ||
| - Go templates: follow the conventions in `base_templates/go/`. |
There was a problem hiding this comment.
The path to the Go templates is agent_starter_pack/base_templates/go/ rather than base_templates/go/. Let's update this to use the full path from the repository root to avoid confusion for contributors and AI agents.
1 participant
Summary
Adds an
AGENTS.mdfile to help AI coding agents (and human contributors) quickly understand the project layout, build/test commands, template development workflow, and contribution conventions.The repository currently has
README.md,CONTRIBUTING.md, andGEMINI.md, but lacks a concise AI-focused onboarding file.AGENTS.mdfills that gap by summarizing the commands and patterns an agent needs before making changes.Type of Change
Test Plan
make install,make lint,make test,_TEST_AGENT_COMBINATION=... make lint-templated-agents) exist in the repository'sMakefileandCONTRIBUTING.md.Related Issues
None.
Notes for Reviewers
This is a documentation-only addition. It does not modify any templates, CLI code, or tests.