# AGENTS.md

JavaScript Style Guide

## Setup

```
npm install
```

## Commands

```
npm run test                  # run the test suite, must pass before any commit
npm run lint                  # lint
npm run preinstall
npm run postinstall
npm run install:config
npm run install:config:base
npm run pretest
npm run test:config
```

## Layout

- `packages/` 28 source files

## Conventions

- Tests live alongside the code they cover, following `packages/eslint-config-airbnb-base/test/.eslintrc`.
- CI defines what passing means. See `.github/workflows/node-pretest.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- No lockfile is committed, so an install here may not match what CI produced.

---

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.