Agent-Agnostic Files
Start here for rules and context that should help every coding assistant work safely in the repo.
AGENTS.md
The shared operating manual every coding agent should read before changing the repo.
Use it for
- repo-specific behavior that applies across tools
- safe defaults, guardrails, and approval boundaries
- exact commands agents can run with confidence
- review, branch, and merge expectations
Should contain
- concise project summary
- preferred workflow
- exact install, test, lint, build, and deploy commands
- branch and PR policy
- actions that need approval
- rules agents should not bypass
PRODUCT.md
Product context that keeps implementation tradeoffs tied to users and outcomes.
Use it for
- target users and use cases
- the problem the product solves
- major workflows and user journeys
- business objectives and success criteria
Should contain
- why the project exists
- who it serves
- what good looks like
- what is in scope and out of scope
- the outcomes that matter most
ANALYTICS.md
A checked-in measurement contract for product events, metrics, attribution, and privacy boundaries.
Use it for
- canonical product and marketing metrics
- event names, properties, identity, and versioning rules
- funnel stages, attribution, and source-of-truth decisions
- consent, privacy, retention, and excluded data
- analytics validation and governance
Should contain
- the outcomes and funnels the product measures
- canonical event and property contracts
- identity, attribution, and metric-source rules
- data that must never be collected
- consent and privacy requirements
- how to validate changes and evolve the schema safely
TECH.md
The technical source of truth for stack, commands, and implementation constraints.
Use it for
- framework and library choices
- runtime and package manager versions
- build, check, test, and deploy commands
- deployment targets, integrations, and APIs
Should contain
- the canonical stack
- supported commands
- preferred libraries and patterns
- external services and APIs
- the constraints agents must respect
STRUCTURE.md
A repo map that helps agents put code, docs, and tests in the right place.
Use it for
- top-level directory layout
- naming conventions
- import patterns
- module boundaries and ownership lines
Should contain
- a directory map
- ownership boundaries
- import rules
- placement rules for new files
- special-case folders that matter for the agent
VISION.md
Long-term direction, non-goals, and taste principles that should outlast individual specs.
Use it for
- long-term product direction
- non-goals
- design and product taste
- the future state the project is trying to create
Should contain
- vision and durable constraints
- what the project should become
- what should not drift
- success criteria at the level of outcomes, not implementation
DESIGN.md
A design-system source of truth for AI-generated UI changes.
Use it for
- design tokens and theme choices
- typography and spacing
- layout rules
- component patterns
- accessibility expectations
Should contain
- the visual language
- spacing and type rules
- layout constraints
- component style preferences
- UI patterns to avoid