# AGENTS.md

Grades any public GitHub repo on how well AI coding agents can work in it

## Setup

```
bun install
```

## Commands

```
bun dev         # run locally
bun test        # run the test suite, must pass before any commit
bun typecheck   # type check without emitting
bun lint        # lint
bun format      # format
bun deploy
```

## Layout

- `src/`        27 source files
- `scripts/`    4 source files
- `migrations/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `src/__tests__/parse.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- 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.

## Gotchas

- Copy `.dev.vars.example` before running anything that needs configuration.

---

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.