# AGENTS.md

Fast, easy and reliable testing for anything that runs in a browser.

## Setup

```
yarn install
```

## Commands

```
yarn dev                   # run locally
yarn start                 # run the app
yarn build                 # produce a build
yarn test                  # run the test suite, must pass before any commit
yarn lint                  # lint
yarn binary-build
yarn binary-deploy
yarn binary-deploy-linux
```

## Layout

- `packages/`     2499 source files
- `system-tests/` 1606 source files
- `npm/`          473 source files
- `cli/`          149 source files
- `scripts/`      106 source files
- `tooling/`      19 source files

## Conventions

- Tests live alongside the code they cover, following `__snapshots__/move-binaries-spec.js`.
- CI defines what passing means. See `.github/workflows/auto_approve_low_risk.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `system-tests/projects/yarn-v3.1.1-pnp/yarn-3.1.1.cjs` is 2148KB. 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.