# AGENTS.md

Breakthrough Method for Agile Ai Driven Development

## Setup

```
npm ci
```

## Commands

```
npm run test             # run the test suite, must pass before any commit
npm run lint             # lint
npm run bmad:install
npm run bmad:uninstall
npm run docs:build
npm run docs:dev
npm run docs:fix-links
npm run docs:preview
```

## Layout

- `tools/`   50 source files
- `src/`     31 source files
- `test/`    11 source files
- `website/` 11 source files

## Conventions

- Tests live alongside the code they cover, following `src/bmm-skills/plan/bmad-architecture/scripts/tests/test_lint_spine.py`.
- CI defines what passing means. See `.github/workflows/coderabbit-review.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `test/test-installation-components.js` is 195KB. 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.