docs: add AGENT.md for AI agent contributors#186
docs: add AGENT.md for AI agent contributors#186ayushozha wants to merge 1 commit intogoogle-agentic-commerce:mainfrom
Conversation
Provides repository overview, structure, key concepts, and coding guidelines for AI agents working in this codebase. Fixes google-agentic-commerce#49 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
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. |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a dedicated Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![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 an AGENT.md file, which serves as a guide for AI agents and automated contributors. The document is comprehensive and well-structured. My feedback includes a minor formatting suggestion to improve the readability of the repository structure diagram for better clarity.
| ``` | ||
| AP2/ | ||
| ├── src/ap2/types/ # Core protocol type definitions (Python/Pydantic) | ||
| │ ├── mandate.py # IntentMandate, CartMandate, PaymentMandate | ||
| │ ├── payment_request.py # PaymentRequest, PaymentResponse (W3C-based) | ||
| │ ├── payment_receipt.py # Payment receipt types | ||
| │ └── contact_picker.py # Contact picker types | ||
| ├── samples/ | ||
| │ ├── python/ | ||
| │ │ ├── scenarios/ # Runnable demo scenarios | ||
| │ │ │ └── a2a/ | ||
| │ │ │ └── human-present/ | ||
| │ │ │ ├── cards/ | ||
| │ │ │ └── x402/ | ||
| │ │ └── src/ | ||
| │ │ ├── roles/ # Agent implementations by role | ||
| │ │ │ ├── shopping_agent/ | ||
| │ │ │ ├── merchant_agent/ | ||
| │ │ │ ├── merchant_payment_processor_agent/ | ||
| │ │ │ └── credentials_provider_agent/ | ||
| │ │ └── common/ # Shared utilities (A2A helpers, config, server) | ||
| │ ├── android/ # Android-based shopping assistant samples | ||
| │ └── go/ # Go-based samples | ||
| ├── docs/ | ||
| │ ├── specification.md # Full protocol specification | ||
| │ ├── glossary.md # Term definitions | ||
| │ ├── faq.md | ||
| │ ├── roadmap.md | ||
| │ └── topics/ # Additional documentation topics | ||
| ├── scripts/ | ||
| │ └── format.sh # Code formatting script | ||
| ├── pyproject.toml # Python package config (uv workspace) | ||
| ├── mkdocs.yml # Documentation site config | ||
| ├── CONTRIBUTING.md # Contribution guidelines and CLA info | ||
| ├── CODE_OF_CONDUCT.md | ||
| ├── SECURITY.md | ||
| └── LICENSE # Apache 2.0 | ||
| ``` |
There was a problem hiding this comment.
The comments in the repository structure diagram are not aligned, which makes it slightly harder to read. For better readability and a cleaner presentation, it's good practice to align all comments to start at the same column.
AP2/
├── src/ap2/types/ # Core protocol type definitions (Python/Pydantic)
│ ├── mandate.py # IntentMandate, CartMandate, PaymentMandate
│ ├── payment_request.py # PaymentRequest, PaymentResponse (W3C-based)
│ ├── payment_receipt.py # Payment receipt types
│ └── contact_picker.py # Contact picker types
├── samples/
│ ├── python/
│ │ ├── scenarios/ # Runnable demo scenarios
│ │ │ └── a2a/
│ │ │ └── human-present/
│ │ │ ├── cards/
│ │ │ └── x402/
│ │ └── src/
│ │ ├── roles/ # Agent implementations by role
│ │ │ ├── shopping_agent/
│ │ │ ├── merchant_agent/
│ │ │ ├── merchant_payment_processor_agent/
│ │ │ └── credentials_provider_agent/
│ │ └── common/ # Shared utilities (A2A helpers, config, server)
│ ├── android/ # Android-based shopping assistant samples
│ └── go/ # Go-based samples
├── docs/
│ ├── specification.md # Full protocol specification
│ ├── glossary.md # Term definitions
│ ├── faq.md
│ ├── roadmap.md
│ └── topics/ # Additional documentation topics
├── scripts/
│ └── format.sh # Code formatting script
├── pyproject.toml # Python package config (uv workspace)
├── mkdocs.yml # Documentation site config
├── CONTRIBUTING.md # Contribution guidelines and CLA info
├── CODE_OF_CONDUCT.md
├── SECURITY.md
└── LICENSE # Apache 2.01 participant
Summary
AGENT.mdfile at the repo root providing a structured overview for AI agents and automated contributors working in this codebaseFixes #49
Test plan
🤖 Generated with Claude Code