Skip to content

chore(agents): point agents at the CLI style guide - #713

Merged
bdsqqq merged 2 commits into
mainfrom
agents-md-style-guide
Nov 20, 2026
Merged

bdsqqq merged 2 commits into
mainfrom
agents-md-style-guide

Conversation

@bdsqqq

@bdsqqq bdsqqq commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Written by Claude Opus 5.5 in Amp on behalf of Igor, in this thread.

Agents changing depot commands never found docs/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's PRODUCT_NAMES.md.

Proof: the guide and symlink resolve, and the gh api command in AGENTS.md returns PRODUCT_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 (with CLAUDE.md as a symlink) so automated agents have a single entry point before touching CLI surface area.

Agents are instructed to read docs/cli-style-guide.md end-to-end (not skim) before changing depot commands, flags, help strings, or output, and to use product names from depot/app's PRODUCT_NAMES.md, including via the documented gh api fetch 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.

bdsqqq and others added 2 commits November 20, 2026 20:52
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>

@claude claude Bot left a comment

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.

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.md points 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 api command: it only reads PRODUCT_NAMES.md from 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.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk: low. Approved. Cursor Bugbot completed with no findings, and this change only adds agent docs plus a CLAUDE.md symlink.

Open in Web View Automation 

Sent by Cursor Approval Agent: Pull Request Router and Approver

@bdsqqq
bdsqqq merged commit ce990b2 into main Nov 20, 2026
13 checks passed
@bdsqqq
bdsqqq deleted the agents-md-style-guide branch November 20, 2026 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant