# AGENTS.md

🧡 Everything is RSSible

## Setup

```
pnpm install
```

## Commands

```
pnpm dev          # run locally
pnpm start        # run the app
pnpm build        # produce a build
pnpm test         # run the test suite, must pass before any commit
pnpm typecheck    # type check without emitting
pnpm lint         # lint
pnpm format       # format
pnpm build:docs
```

## Layout

- `lib/`            6701 source files
- `scripts/`        12 source files
- `eslint-plugins/` 1 source file

## Conventions

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

## Gotchas

- `lib/routes/zcool/locations.ts` is 147KB. 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.