# AGENTS.md

Declarative routing for React

## Setup

```
pnpm install
```

## Commands

```
pnpm build             # produce a build
pnpm test              # run the test suite, must pass before any commit
pnpm typecheck         # type check without emitting
pnpm lint              # lint
pnpm format            # format
pnpm watch
pnpm changes:add
pnpm changes:publish
```

## Layout

- `packages/`    379 source files
- `playground/`  146 source files
- `integration/` 133 source files
- `scripts/`     24 source files
- `tutorials/`   5 source files
- `jest/`        3 source files

## Conventions

- Tests live alongside the code they cover, following `integration/abort-signal-test.ts`.
- CI defines what passing means. See `.github/workflows/change-file-check.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/react-router/__tests__/dom/data-browser-router-test.tsx` is 271KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.