Skip to content

Consolidate agent instructions into AGENTS.md#7984

Open
amcaplan wants to merge 1 commit into
mainfrom
update-agent-guidelines
Open

Consolidate agent instructions into AGENTS.md#7984
amcaplan wants to merge 1 commit into
mainfrom
update-agent-guidelines

Conversation

@amcaplan

@amcaplan amcaplan commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

What?

Related to https://github.com/shop/issues-develop/issues/22870

Consolidates our agent/AI-assistant instructions into a single standard AGENTS.md (https://agents.md/) instead of duplicating them across Cursor-specific rule files.

Why?

We were maintaining the same guidance in two places:

  • AGENTS.md (changesets policy only)
  • .cursor/rules/base.mdc (full coding guidelines + changesets policy, duplicated)
  • .cursor/rules/docs.mdc (links to docs)

Cursor isn't widely used on the team anymore, but Claude Code, and other agent tooling already looks for AGENTS.md. Keeping the full instructions there and pointing everything else at it avoids drift.

Changes

  • AGENTS.md: now the canonical source — merged in the coding guidelines and doc links that used to live only in the Cursor rules.
  • .claude/CLAUDE.md: now just points to AGENTS.md.
  • .cursor/rules/base.mdc: now a thin pointer to AGENTS.md (kept required frontmatter).
  • .cursor/rules/docs.mdc: removed, content folded into AGENTS.md.

No user-facing behavior change, so no changeset.

Cursor is no longer widely used, so .cursor/rules/base.mdc and docs.mdc
duplicated content that should live in a single standard AGENTS.md
(https://agents.md/). CLAUDE.md and the Cursor rule now just point to
AGENTS.md instead of duplicating its content.

Assisted-By: devx/952e932f-652c-498f-8052-b2f61ce56cf7
Copilot AI review requested due to automatic review settings July 2, 2026 15:57
@amcaplan amcaplan requested a review from a team as a code owner July 2, 2026 15:57
@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Jul 2, 2026

Copilot AI 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.

Pull request overview

This PR consolidates agent/AI-assistant guidance into a single canonical AGENTS.md, replacing duplicated instructions previously kept in Cursor-specific rule files, and updates other tooling entrypoints to point at AGENTS.md.

Changes:

  • Expanded AGENTS.md to include general coding guidelines and “Further reading” links in addition to the existing changesets policy.
  • Updated .claude/CLAUDE.md and .cursor/rules/base.mdc to become thin pointers to AGENTS.md.
  • Removed .cursor/rules/docs.mdc and folded its link content into AGENTS.md.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
AGENTS.md Becomes the canonical, expanded agent-instructions document (guidelines + further reading + changesets).
.cursor/rules/docs.mdc Removed; its content is moved into AGENTS.md.
.cursor/rules/base.mdc Reduced to a pointer to AGENTS.md while keeping required frontmatter.
.claude/CLAUDE.md Simplified to reference AGENTS.md only.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md

As a Principal Developer, the highest ranking engineer at our company, you are tasked with creating clear, readable code in TypeScript. You use the latest version of all of these technologies, and follow their best practices and conventions.

When responding to questions, follow the Chain of Thought method. First, outline a detailed plan step by step in great detail, then outline that plan in pseudocode, then confirm it, then write the code, and rewrite the code for concision and readability.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants