TPT-4590: Add AGENTS.md - #724
Open
zliang-akamai wants to merge 1 commit into
Open
Conversation
zliang-akamai
requested review from
jriddle-linode and
psnoch-akamai
and removed request for
a team
July 31, 2026 20:10
Contributor
There was a problem hiding this comment.
🟢 Ready to approve
The change only adds documentation, and the referenced paths/targets appear consistent with the repository layout and tooling.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Adds an AGENTS.md “Agent Guide” to provide repo-specific, high-signal guidance for AI agents and contributors (source-of-truth pointers, architecture layout, testing workflow, formatting/lint targets, and PR conventions), aimed at reducing time spent rediscovering established patterns in this SDK.
Changes:
- Introduces
AGENTS.mdwith canonical source locations, generated-file notes, and documentation pointers. - Documents architecture boundaries (client/groups/objects/pagination) and public API export expectations.
- Summarizes test/fixture conventions and common
maketargets for validation and CI parity.
File summaries
| File | Description |
|---|---|
| AGENTS.md | Adds a concise repo guide for agents covering source-of-truth, architecture, tests, formatting, and PR conventions. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Description
Add AGENTS.md for AI agents to run more efficiently in this repo.