AGENTS.md and CLAUDE.md examples for TypeScript

Real files to read

From the best-known open-source TypeScript products whose file is a real one (not a pointer to another), 200 to 4,000 words, covering at least three of the usual topics, written mainly in TypeScript. Each opens on GitHub.

What TypeScript projects put in them

Share of the 521 files that cover each topic, against all 641 files we read.

How they talk to the agent: 80% say “never” or “do not” somewhere (all files: 80%), 23% shout a rule in capitals like IMPORTANT or MUST (24%), and 19% tell it to ask before some changes (20%).

The tools they name

Package managerspnpm (142 files), npm (121 files), bun (71 files)

Tests and lintersVitest (112), Playwright (105), ESLint (91), Prettier (63), pytest (62), Biome (39)

The sections these files cover most, the package manager and checks TypeScript projects name most, and the stack TypeScript makers' products chose most often. Fill in the <placeholders>.

# AGENTS.md

<What this product does and who it is for, in a sentence or two.>

## Stack


## Commands

- Install: `pnpm install`
- Run locally: `<command>`
- Test: `pnpm exec vitest run`
- End-to-end tests: `pnpm exec playwright test`
- Lint: `pnpm exec eslint .`

## Testing

Run `pnpm exec vitest run` and `pnpm exec playwright test` before calling a change done, and add a test with each fix or feature.

## Project structure

- `<folder>/`: <what lives there>
- More in <docs/…>

## Conventions

- <Naming, patterns and style the code does not show>
- Commits and pull requests: <your rules>

## Boundaries

- Ask before: <changes you want to approve first>
- Never: <files or actions that are off-limits>

<!-- Started from https://howmakersbuild.com/agents-md/typescript — point CLAUDE.md here with a line: @AGENTS.md -->

• pnpm: named in 142 of 521 instruction files from open-source projects built with TypeScript.
• Vitest: named in 112 of 521 instruction files from open-source projects built with TypeScript.
• Playwright: named in 105 of 521 instruction files from open-source projects built with TypeScript.
• ESLint: named in 91 of 521 instruction files from open-source projects built with TypeScript.

Make one for your own stack →

Questions