diff --git a/AGENTS.md b/AGENTS.md deleted file mode 100644 index d758d1a2..00000000 --- a/AGENTS.md +++ /dev/null @@ -1,117 +0,0 @@ -# AGENTS.md - -Repo-wide guidance. Per-app specifics live in each workspace's own `AGENTS.md` / `README.md`. - -## Layout - -A Bun monorepo. Apps live under `apps/*`; reusable framework code lives under `packages/*`. The current state is one app (`order-book-*`) plus a framework package (`typewriter`) being extracted from it. The repo root also defines a Cargo workspace (`Cargo.toml`) whose only member is the Rust crate at `packages/typewriter-evm`. - -## Docs - -`README.md` and `packages/typewriter/README.md` are copies of each other. Keep them in sync when editing either file. - -## Common commands - -Run from the repo root: - -```bash -bun install -bun run lint # biome + per-workspace lint -bun run typecheck # tsc --noEmit per workspace -bun run build # per-workspace builds -``` - -The root `typecheck` script is intentionally sequential instead of -`bun run --filter '*' typecheck`: Bun can run filtered workspace scripts in -parallel, which makes dependent workspaces typecheck `storage-layout` at the -same time and can create enough TypeScript memory pressure to crash small remote -instances. Keep it one workspace at a time unless the type setup changes to use -project references or declaration boundaries. - -## Before declaring work complete - -Run all three checks at the repo root before saying a task is done — not just one: - -- `bun run lint` — Biome formatter + linter (catches formatting drift, unused vars, style violations) -- `bun run typecheck` — `tsc --noEmit` per workspace -- `bun run test` — per-workspace test scripts - -For type-only changes (`.d.ts`, type tests, or purely compile-time inference -work), `bun run test` is not required when `bun run lint` and -`bun run typecheck` pass. Say explicitly that tests were skipped because the -change is type-only. - -`bun run typecheck` alone is not sufficient: Biome catches things TS doesn't (formatting, unused imports under different rules), and TS catches things Biome doesn't (`noUnusedLocals`, type narrowing). Pre-existing failures unrelated to your changes are fine to flag and skip past, but don't introduce new ones. - -## Bun-first conventions - -This is a Bun project; default to Bun APIs over Node/npm equivalents. - -- Run files with `bun `, not `node` or `ts-node`. -- `bun install` / `bun run