ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

docs: add JavaScript conventions guide 

Establishes callers-above-callees function ordering rule
and references it from AGENTS.md.
This commit is contained in:
Alex Verkhovsky 2026-03-21 01:42:23 -06:00
parent 93a1e1dc46
commit efca29485e
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AGENTS.md
View File

@ -8,5 +8,6 @@ Open source framework for structured, agent-assisted software delivery.
- Before pushing, run `npm ci && npm run quality` on `HEAD` in the exact checkout you are about to push. - Before pushing, run `npm ci && npm run quality` on `HEAD` in the exact checkout you are about to push.
`quality` mirrors the checks in `.github/workflows/quality.yaml`. `quality` mirrors the checks in `.github/workflows/quality.yaml`.
- If you are writing JavaScript, read `tools/javascript-conventions.md`.
- Skill validation rules are in `tools/skill-validator.md`. - Skill validation rules are in `tools/skill-validator.md`.
- Deterministic skill checks run via `npm run validate:skills` (included in `quality`). - Deterministic skill checks run via `npm run validate:skills` (included in `quality`).

5
tools/javascript-conventions.md Normal file
View File

@ -0,0 +1,5 @@
# JavaScript Conventions
## Function ordering
Define functions top-to-bottom in call order: callers above callees. If `install()` calls `_initPaths()`, then `install` appears first and `_initPaths` appears after it.