# AGENTS.md

The web framework for content-driven websites. ⭐️ Star to support our work!

## Setup

```
pnpm install
```

## Commands

```
pnpm dev         # run locally
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 release
pnpm build:ci
```

## Layout

- `packages/`  4337 source files
- `examples/`  165 source files
- `benchmark/` 60 source files
- `scripts/`   9 source files

## Conventions

- Tests live alongside the code they cover, following `configs/tsconfig.test.json`.
- 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/check-merge.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/astro/src/types/public/config.ts` is 125KB. 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.