Skip to content

docs: add build, architecture, and convention sections to AGENTS.md#311

Open
dpearson2699 wants to merge 2 commits intogetsentry:mainfrom
dpearson2699:docs/update-agents-md
Open

docs: add build, architecture, and convention sections to AGENTS.md#311
dpearson2699 wants to merge 2 commits intogetsentry:mainfrom
dpearson2699:docs/update-agents-md

Conversation

@dpearson2699
Copy link
Copy Markdown

@dpearson2699 dpearson2699 commented Apr 4, 2026

Syncs AGENTS.md with CLAUDE.md by adding sections that were already present in CLAUDE.md but missing from AGENTS.md.

Added sections

  • Build & Test - all npm scripts agents need to run (build, test, lint, typecheck, docs:update, etc.)
  • Architecture - component map of src/ layers with one-line descriptions
  • Developer Documentation - links to all docs/dev/ guides (contributing, architecture, testing, manifests, release, code quality)
  • Contributing Workflow - step-by-step instructions including the pre-commit checklist
  • Import Conventions - ESM, .ts extensions in src/, no barrel imports
  • Test Conventions - Vitest patterns, colocated tests, smoke tests, dependency injection requirements
  • Tool Development - manifest-driven tool registration, handler shape, resource exports

Why

AI agents reading AGENTS.md (Copilot, Windsurf, Cursor, etc.) were missing build commands, architecture context, contributing workflows, and convention details that were already documented in CLAUDE.md. This caused agents to guess at import styles, test patterns, and project structure rather than following established conventions. The contributing workflow and dev doc links are critical for agents to know the full PR preparation process.

Other changes

  • Clean up stray trailing hyphens on empty lines between sections

Add sections that were already present in CLAUDE.md but missing from
AGENTS.md, bringing the two files into sync:

- Build & Test: all npm scripts agents need to run
- Architecture: component map of src/ layers
- Import Conventions: ESM, .ts extensions, no barrel imports
- Test Conventions: Vitest patterns, colocated tests, smoke tests
- Tool Development: manifest-driven tool registration pattern

Also clean up stray trailing hyphens on blank lines.
@dpearson2699 dpearson2699 force-pushed the docs/update-agents-md branch from 6e1f57c to 0b49fe9 Compare April 4, 2026 20:15
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