# AGENTS.md

React-based framework with performance, scalability, and security built in.

## Setup

```
yarn install
```

## Commands

```
yarn test                # run the test suite, must pass before any commit
yarn typecheck           # type check without emitting
yarn lint                # lint
yarn format              # format
yarn bootstrap
yarn check-repo-fields
yarn check-versions
yarn format:code
```

## Layout

- `packages/`            1893 source files
- `e2e-tests/`           741 source files
- `examples/`            591 source files
- `integration-tests/`   337 source files
- `benchmarks/`          263 source files
- `deprecated-packages/` 194 source files

## Conventions

- Tests live alongside the code they cover, following `.github/actions/high-priority-prs/src/__tests__/__snapshots__/pr-message.js.snap`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/schedule-stale.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `.yarn/releases/yarn-1.21.0.js` is 4974KB. 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.