Files
aj-geddes__claude-code-bmad…/CONTRIBUTING.md
T
AJ Geddes 7edc6d0f0a feat: rebuild as BMAD Planning & Orchestrator Claude Code plugin
Rewrite the repo from a skills installer into a Claude Code plugin (distributed
via marketplace) that harnesses the BMAD Method v6.x for PLANNING and
ORCHESTRATION only — it never writes code. Implementation is handed off to
external dev tools.

Built:
- Plugin bmad-planning-orchestrator (.claude-plugin/plugin.json) + repo-root
  marketplace (bmad-method-harness)
- 20 planning/orchestration skills aligned to current BMAD v6.x: skills-centric,
  scale-adaptive tracks (Quick Flow / BMad Method / Enterprise) not Levels,
  five-field SPEC kernel, three-intent PRD/brief, two-document UX
  (DESIGN.md + EXPERIENCE.md), persistent decision-log, compiled-context stories
- Parallel orchestration: epics/stories with disjoint Owned File/Module Scope,
  bmad-parallel-plan (dependency DAG -> conflict-free waves + merge order),
  bmad-handoff (tool-agnostic handoff-manifest.json with a versioned schema)
- 3 planning subagents (tools-restricted, no code execution), next-step hooks,
  shared scripts (incl. scope-conflict-check.sh), 5 resource guides
- Docs site, root+plugin README, CLAUDE.md, CONTRIBUTING, MIGRATION, CHANGELOG

Removed (refocus to planning/orchestration):
- developer skill, /dev-story, lint/coverage/pre-commit execution
- Fibonacci story points, velocity, burndown (now one-dev-day sizing +
  count-based delivery)
- install-v6.sh/.ps1 installers (marketplace install replaces them)
- the dual bmad-v6/ + bmad-skills/ source trees (collapsed into one plugin)

Attribution to the BMAD Code Organization preserved and strengthened throughout
(LICENSE clause, ATTRIBUTION.md, per-skill footers, manifest author/homepage,
resources/bmad-method-mapping.md). This plugin is an independent harness; the
BMAD Method belongs to the BMAD Code Organization.

Verified: validate-skill 20/20; all .py compile; all .sh pass bash -n; all JSON
valid; handoff template validates against its schema; scripts executed on sample
data by an adversarial functional review.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-19 20:58:01 -05:00

3.5 KiB

Contributing

Thanks for helping improve the BMAD Planning & Orchestrator plugin. Please keep the credit where it belongs: the BMAD Method™ is the work of the BMAD Code Organization; this repo is only a Claude Code harness for it. Do not remove or weaken attribution, and don't alter the BMAD methodology itself — coordinate upstream for that.

The line you must not cross

This plugin plans and orchestrates work. It never implements it.

A contribution is in scope if it helps plan, document, sequence, or hand off work. It is out of scope the moment it tries to write application code, run tests, lint, check coverage, build, or review an implemented diff. The furthest the plugin goes is producing a ready-for-dev story file and a handoff manifest.

bmad-builder's validate-skill.sh flags scope-leak language; a PR that introduces code execution will be rejected even if it "works."

Adding or editing a skill

Skills live in bmad-planning-orchestrator/skills/<name>/.

  1. Scaffold: ./bmad-planning-orchestrator/skills/bmad-builder/scripts/scaffold-skill.sh <name>
  2. SKILL.md rules:
    • YAML frontmatter: name (== directory), description (≤1024 chars, with concrete "use when…" trigger phrases), allowed-tools (planning tools only).
    • Body ≤ ~5K tokens; put long reference detail in REFERENCE.md.
    • Use ${CLAUDE_PLUGIN_ROOT} for every bundled path; never hardcode ~/.claude or absolute paths; never ../ out of the plugin root.
    • End with the BMAD attribution footer (see any existing skill).
  3. Follow BMAD fidelity: tracks not Levels (Quick Flow / BMad Method / Enterprise); no story points / velocity / burndown (one-dev-day sizing, count-based delivery); three-intent (Create/Update/Validate) where it fits; the story-file contract (locked AC/Dev Notes/Testing, Owned File/Module Scope, source-cited Dev Notes).
  4. If the skill maps to an upstream BMAD skill, add the row to bmad-planning-orchestrator/resources/bmad-method-mapping.md.

Before you open a PR

# Frontmatter + scope-leak check on every skill
find bmad-planning-orchestrator/skills -name SKILL.md \
  -exec ./bmad-planning-orchestrator/skills/bmad-builder/scripts/validate-skill.sh {} \;

# Manifests parse
python3 -m json.tool .claude-plugin/marketplace.json >/dev/null
python3 -m json.tool bmad-planning-orchestrator/.claude-plugin/plugin.json >/dev/null

# Scripts executable
find bmad-planning-orchestrator -name "*.sh" -o -name "*.py" | xargs chmod +x

# Smoke-test locally
claude --plugin-dir ./bmad-planning-orchestrator

Bump version in plugin.json for user-visible changes and add a CHANGELOG entry noting which upstream BMAD v6.x the change tracks.

Good contributions

  • New or improved planning/orchestration skills (e.g. better elicitation, new planning document shapes from upstream BMAD).
  • Better track right-sizing, dependency/parallel-wave planning, handoff-manifest adapters for more dev runners.
  • Documentation, examples, and keeping bmad-method-mapping.md in sync with upstream BMAD v6.x.

Style

Functional and direct. Persona names (Mary/John/Winston/Sally) are fine as flavor in prose, but skills are workflows, not characters — no heavy persona overhead. Match the surrounding skills' structure and tone.

License

By contributing you agree your work is licensed under MIT. The BMAD Method™ name and methodology remain the property of the BMAD Code Organization.