# AGENTS.md

:zap: Dynamically generated stats for your github readmes

## Setup

```
npm ci
```

## Commands

```
npm run test                   # run the test suite, must pass before any commit
npm run lint                   # lint
npm run format                 # format
npm run test:watch
npm run test:update:snapshot
npm run test:e2e
npm run theme-readme-gen
npm run preview-theme
```

## Layout

- `src/`     33 source files
- `tests/`   33 source files
- `api/`     7 source files
- `scripts/` 6 source files
- `themes/`  1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/e2e-test.yml`.
- CI defines what passing means. See `.github/workflows/codeql-analysis.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.