# AGENTS.md

A JS library for predictable global state management

## Setup

```
yarn install
```

## Commands

```
yarn build          # produce a build
yarn test           # run the test suite, must pass before any commit
yarn lint           # lint
yarn format         # format
yarn clean
yarn format:check
yarn type-tests
yarn test:watch
```

## Layout

- `examples/` 149 source files
- `test/`     23 source files
- `src/`      17 source files
- `website/`  5 source files
- `docs/`     1 source file

## Conventions

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

## Gotchas

- `.yarn/releases/yarn-4.4.1.cjs` is 2689KB. 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.