mirror of https://github.com/bmad-code-org/BMAD-METHOD.git synced 2026-09-19 08:11:52 +08:00

Files

T

Alex Verkhovsky fa1637ee40 build: move the Node toolchain into docs-site (#2834 )

The root package.json, lockfile, .nvmrc, prettier ignore file and
.npmignore are gone. docs-site has its own package.json and lockfile
with the Astro, ESLint and Prettier dependencies, and its scripts run
relative to that directory. tools/quality.py, both workflows and the
docs all call npm inside docs-site.

stamp_release.py stamps only the 29 skill manifests now; the version
lives nowhere else on this branch. The tests for package stamping go
with it.

2026-09-05 18:11:37 -06:00

1.5 KiB

Raw Permalink Blame History

BMAD-METHOD

Open source framework for structured, agent-assisted software delivery.

Rules

Use Conventional Commits for every commit.
Before pushing, run uv sync --frozen && (cd docs-site && npm ci) && uv run --frozen tools/quality.py on HEAD in the exact checkout you are about to push. It mirrors the checks in .github/workflows/quality.yaml.
Run uv run pre-commit install once per clone; the commit hook runs the Python-side lint and validation from the quality script.
Skill validation rules are in tools/skill-validator.md.
Deterministic skill checks run via uv run tools/validate_skills.py --strict (included in the quality script).
Documentation conventions are in docs/_STYLE_GUIDE.md.

Writing prompts

Skills, workflows, tasks, and agent definitions are prompt text that an agent reads in full on every run. Length and ambiguity are paid on every run; a corner case is paid only when it occurs. So do not add instructions for exotic cases — the model usually handles them from context, and the reviewing human can correct it when it does not.

Testing

Automated tests assert outcomes produced by deterministic code. Do not write automated tests for LLM output or for static source text.

Releases

Read tools/release.md before cutting a release. Stamp on dev, fast-forward main with git push origin dev:main, tag that commit, then stamp the next placeholder on dev. No release PR or back-merge. The 6.12 npm installer is maintained separately on V6.12.