Repository navigation
chore(agents): point agents at the CLI style guide - #713
Merged
Merged
Conversation
Agents changing commands, flags, help text, or output now read docs/cli-style-guide.md in full. Nothing linked the guide before, so agents didn't find it. Amp-Thread-ID: https://ampcode.com/threads/T-01a1f4ff-9f7a-76fe-a324-1e01e69454ec Co-authored-by: Amp <amp@ampcode.com>
Contributor
There was a problem hiding this comment.
LGTM. This is a small docs-only change that adds agent guidance.
What was reviewed:
- The new AGENTS.md: its relative link to
docs/cli-style-guide.mdpoints to a file that exists in this checkout. - CLAUDE.md: it's a symlink (mode 120000) whose target is
AGENTS.md, so both names serve the same content. - The suggested
gh apicommand: it only readsPRODUCT_NAMES.mdfrom depot/app and doesn't write anything. I didn't run it here.
Extended reasoning...
The change adds a 12-line AGENTS.md and a CLAUDE.md symlink to it. No code, build config, or runtime behavior changes. The only security-adjacent content is a read-only gh api command for agents to fetch a product-names doc, and it exposes no credentials or data. The linked style guide exists in the repo, and no CODEOWNERS file covers these paths. The timeline shows no reviewer objections.
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.


Written by Claude Opus 5.5 in Amp on behalf of Igor, in this thread.
Agents changing
depotcommands never founddocs/cli-style-guide.md: this repo had no AGENTS.md, and nothing linked the guide. This adds one (with CLAUDE.md as a symlink) that tells agents to read the style guide in full before changing commands, flags, help text, or output, and to take product names from depot/app'sPRODUCT_NAMES.md.Proof: the guide and symlink resolve, and the
gh apicommand in AGENTS.md returnsPRODUCT_NAMES.md. Reviewed with sol-loop: 1 round with GPT-6.1 Sol; both findings fixed.Catch up on this pull request in Depot
Note
Low Risk
Documentation-only change with no runtime or CLI behavior impact.
Overview
Adds
AGENTS.md(withCLAUDE.mdas a symlink) so automated agents have a single entry point before touching CLI surface area.Agents are instructed to read
docs/cli-style-guide.mdend-to-end (not skim) before changingdepotcommands, flags, help strings, or output, and to use product names fromdepot/app'sPRODUCT_NAMES.md, including via the documentedgh apifetch when a local checkout isn't available.Reviewed by Cursor Bugbot for commit 85f16eb. Bugbot is set up for automated code reviews on this repo. Configure here.