# AGENTS.md

Build forms in React, without the tears 😭 

## Setup

```
yarn install
```

## Commands

```
yarn dev                 # run locally
yarn build               # produce a build
yarn test                # run the test suite, must pass before any commit
yarn format              # format
yarn build:benchmark
yarn build:codesandbox
yarn prepublish
yarn changeset
```

## Layout

- `website/`  66 source files
- `packages/` 26 source files
- `examples/` 25 source files
- `app/`      5 source files
- `scripts/`  3 source files
- `e2e/`      1 source file

## Conventions

- Tests live alongside the code they cover, following `e2e/basic.test.ts`.
- 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/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.