Skip to content

Commit 883c5d0

Browse files
authored
feat: add bmad-module-builder skill (#48)
* feat: add bmad-module-builder skill with ideation, creation, and validation New skill (bmad-module-builder) with three capabilities: - Ideate Module (IM): facilitative brainstorming for module planning - Create Module (CM): scaffold setup skill into existing skills folder - Validate Module (VM): structural and quality validation of module setup Includes scaffold script with tests, setup-skill-template assets, resumable plan document template, and embedded brainstorming techniques. Documentation updates: - New explanation doc: what-are-modules.md (architecture, memory patterns) - New tutorial: build-your-first-module.md (full Diataxis tutorial) - Updated builder-commands.md with Module Builder reference - Updated module-configuration.md (replaced Upcoming Tooling section) - Updated help CSVs with IM, CM, VM entries * style: apply prettier formatting to all changed files * style: format entire repo with prettier
1 parent b1332e0 commit 883c5d0

97 files changed

Lines changed: 4253 additions & 1354 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude-plugin/marketplace.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"name": "bmad-builder",
1313
"source": "./",
1414
"description": "Build AI agents and workflows from a conversation. Three skills — Agent Builder, Workflow Builder, and Setup — guide you from idea to production-ready skill structure with built-in quality optimization. Part of the BMad Method ecosystem.",
15-
"version": "1.1.0",
15+
"version": "1.2.0",
1616
"author": {
1717
"name": "Brian (BMad) Madison"
1818
},

.github/ISSUE_TEMPLATE/issue.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ assignees: ''
1010
A clear and concise description of what the bug is.
1111

1212
**Steps to reproduce**
13+
1314
1. What were you doing when the bug occurred?
1415
2. What steps can recreate the issue?
1516

1617
**Expected behavior**
1718
A clear and concise description of what you expected to happen.
1819

1920
**Environment (if relevant)**
21+
2022
- Model(s) used:
2123
- Agentic IDE used:
2224
- BMad version:

AGENTS.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@
77
## Key Commands
88

99
### Development
10+
1011
```bash
1112
npm run docs:dev # Start Astro dev server (http://localhost:4321)
1213
npm run docs:build # Build documentation site
1314
npm run docs:preview # Preview built site
1415
```
1516

1617
### Testing & Validation
18+
1719
```bash
1820
npm test # Run full test suite (schemas, refs, lint, format, md)
1921
npm run test:schemas # Validate agent YAML schemas
@@ -23,6 +25,7 @@ npm run validate:refs # Check file references (alias for above)
2325
```
2426

2527
### Code Quality
28+
2629
```bash
2730
npm run lint # ESLint check
2831
npm run lint:fix # ESLint auto-fix
@@ -32,6 +35,7 @@ npm run format:fix # Prettier format
3235
```
3336

3437
### Release
38+
3539
```bash
3640
npm run release # Bump patch version and push tag
3741
npm run release:minor # Bump minor version
@@ -41,13 +45,15 @@ npm run release:major # Bump major version
4145
## Architecture
4246

4347
### Source Structure (`src/`)
48+
4449
- **`agents/`** — Agent definitions (`*.agent.yaml`) with persona, menu, and metadata
4550
- **`workflows/`** — Multi-step guided processes organized by type (agent, workflow, module)
4651
- Each workflow has `steps-c/` (create), `steps-e/` (edit), `steps-v/` (validate)
4752
- Step-file architecture: JIT loading, sequential execution, state tracking
4853
- `data/` contains CSV knowledge bases for agents
4954

5055
### Module Structure
56+
5157
```
5258
your-module/
5359
├── src/
@@ -59,15 +65,18 @@ your-module/
5965
```
6066

6167
### Build Tools (`tools/`)
68+
6269
- **`build-docs.mjs`** — Consolidates docs, generates LLM-friendly files (`llms.txt`), builds Astro site
6370
- **`validate-file-refs.mjs`** — Validates cross-file references in agents/workflows
6471

6572
### Documentation (`docs/`)
73+
6674
- Diataxis structure: tutorials, how-to, explanation, reference
6775
- Starlight-based site in `website/`
6876
- `_STYLE_GUIDE.md` — Project-specific writing conventions (Google style + Diataxis)
6977

7078
### Skills (`.claude/skills/`)
79+
7180
- BMad OS (Open Source) skills for maintainer workflows
7281
- `bmad-os-add-doc` — Diataxis documentation authoring
7382
- `bmad-os-release-module` — Module release process
@@ -76,19 +85,22 @@ your-module/
7685
## Important Concepts
7786

7887
### Agent YAML Structure
88+
7989
- `agent.metadata` — id, name, title, icon, module
8090
- `agent.persona` — role, identity, communication_style, principles
8191
- `agent.menu` — trigger commands that execute workflows
8292
- `conversational_knowledge` — CSV files loaded at runtime
8393

8494
### Workflow Step Architecture
95+
8596
- Micro-file design: each step is self-contained
8697
- Just-in-time loading: only current step in memory
8798
- Sequential enforcement with state tracking
8899
- Menus halt execution waiting for user input
89100
- Frontmatter defines: name, description, web_bundle, createWorkflow
90101

91102
### Path Variables
103+
92104
- `{project-root}/_bmad/bmb/` — Installation path (in repo, maps to `src/`)
93105
- `{bmad_builder_output_folder}` — User's custom content output
94106
- Runtime variables: `{output_folder}`, `{project-root}` from Core config
@@ -104,4 +116,4 @@ your-module/
104116

105117
## Publishing
106118

107-
BMad modules are published as npm packages. The module code (`src/`) is what gets installed into user projects via `npx bmad-method install`. The astro website is deployed separately (GitHub Pages via CNAME).
119+
BMad modules are published as npm packages. The module code (`src/`) is what gets installed into user projects via `npx bmad-method install`. The astro website is deployed separately (GitHub Pages via CNAME).

CHANGELOG.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,3 @@
2323

2424
First official v1 release of BMad Builder — a standard skill-compliant factory for creating BMad Agents, Workflows, and Modules.
2525
The module specific skill is coming soon pending alignment on final format with skill transition.
26-

CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@ Thank you for considering contributing! We believe in **Human Amplification, Not
1111
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**
1212

1313
**✅ What we welcome:**
14+
1415
- Enhanced collaboration patterns and workflows
1516
- Improved agent personas and prompts
1617
- Domain-specific modules leveraging BMad Core
1718
- Better planning and context continuity
1819

1920
**❌ What doesn't fit:**
21+
2022
- Purely automated solutions that sideline humans
2123
- Complexity that creates barriers to adoption
2224
- Features that fragment BMad Core's foundation
@@ -97,17 +99,21 @@ If your change exceeds 800 lines, break it into smaller PRs that can be reviewed
9799

98100
```markdown
99101
## What
102+
100103
[1-2 sentences describing WHAT changed]
101104

102105
## Why
106+
103107
[1-2 sentences explaining WHY this change is needed]
104108
Fixes #[issue number]
105109

106110
## How
111+
107112
- [2-3 bullets listing HOW you implemented it]
108113
-
109114

110115
## Testing
116+
111117
[1-2 sentences on how you tested this]
112118
```
113119

@@ -130,7 +136,7 @@ Keep messages under 72 characters. Each commit = one logical change.
130136

131137
## What Makes a Good PR?
132138

133-
| ✅ Do | ❌ Don't |
139+
| ✅ Do | ❌ Don't |
134140
| --------------------------- | ---------------------------- |
135141
| Change one thing per PR | Mix unrelated changes |
136142
| Clear title and description | Vague or missing explanation |

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ BMad Builder lets you create:
2525

2626
## What Makes It Different
2727

28-
| Feature | Why It Matters |
29-
|---------|----------------|
30-
| **Persistent Memory** | Agents remember across sessions — they learn and grow |
31-
| **Composable** | Your creations work alongside the entire BMad ecosystem |
32-
| **Skill-Compliant** | Built on open standards that work with any AI tool |
33-
| **Shareable** | Package your modules for the BMad Marketplace (coming soon) |
28+
| Feature | Why It Matters |
29+
| --------------------- | ----------------------------------------------------------- |
30+
| **Persistent Memory** | Agents remember across sessions — they learn and grow |
31+
| **Composable** | Your creations work alongside the entire BMad ecosystem |
32+
| **Skill-Compliant** | Built on open standards that work with any AI tool |
33+
| **Shareable** | Package your modules for the BMad Marketplace (coming soon) |
3434

3535
## What You Can Build
3636

37-
| Domain | Example |
38-
|--------|---------|
39-
| **Personal** | Journal companion, habit coach, learning tutor |
37+
| Domain | Example |
38+
| ---------------- | ----------------------------------------------------------- |
39+
| **Personal** | Journal companion, habit coach, learning tutor |
4040
| **Professional** | Code reviewer, documentation specialist, workflow automator |
41-
| **Creative** | Story architect, character developer, campaign designer |
42-
| **Any Domain** | If you can describe it, you can build it |
41+
| **Creative** | Story architect, character developer, campaign designer |
42+
| **Any Domain** | If you can describe it, you can build it |
4343

4444
## Learn More
4545

SECURITY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
We release security patches for the following versions:
66

7-
| Version | Supported |
8-
| ------- | ------------------ |
9-
| Latest | :white_check_mark: |
10-
| < Latest | :x: |
7+
| Version | Supported |
8+
| -------- | ------------------ |
9+
| Latest | :white_check_mark: |
10+
| < Latest | :x: |
1111

1212
We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.
1313

docs/404.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Page Not Found
33
template: splash
44
---
55

6-
76
The page you're looking for doesn't exist or has been moved.
87

98
[Return to Home](/index.md)

docs/_STYLE_GUIDE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Documentation Style Guide"
2+
title: 'Documentation Style Guide'
33
description: Project-specific documentation conventions based on Google style and Diataxis structure
44
---
55

@@ -55,8 +55,8 @@ Critical warnings only — data loss, security issues
5555
```md
5656
| Phase | Name | What Happens |
5757
| ----- | -------- | -------------------------------------------- |
58-
| 1 | Analysis | Brainstorm, research *(optional)* |
59-
| 2 | Planning | Requirements — PRD or tech-spec *(required)* |
58+
| 1 | Analysis | Brainstorm, research _(optional)_ |
59+
| 2 | Planning | Requirements — PRD or tech-spec _(required)_ |
6060
```
6161

6262
**Commands:**

docs/explanation/index.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
11
---
2-
title: "BMad Builder (BMB)"
2+
title: 'BMad Builder (BMB)'
33
description: Create custom agents, workflows, and skills with BMad
44
---
55

66
Create world-class AI agents and workflows with the BMad Builder.
77

88
## Core Concepts
99

10-
| Topic | Description |
11-
|-------|-------------|
12-
| **[What Are Skills](/explanation/what-are-skills.md)** | The universal building block for everything BMad produces |
13-
| **[What Are Agents](/explanation/what-are-bmad-agents.md)** | AI personas with specialized capabilities and memory |
14-
| **[What Are Workflows](/explanation/what-are-workflows.md)** | Structured step-by-step processes and utilities |
10+
| Topic | Description |
11+
| ---------------------------------------------------------------- | --------------------------------------------------------------------------------- |
12+
| **[What Are Skills](/explanation/what-are-skills.md)** | The universal building block for everything BMad produces |
13+
| **[What Are Agents](/explanation/what-are-bmad-agents.md)** | AI personas with specialized capabilities and memory |
14+
| **[What Are Workflows](/explanation/what-are-workflows.md)** | Structured step-by-step processes and utilities |
15+
| **[What Are Modules](/explanation/what-are-modules.md)** | How agents and workflows combine into installable, configurable modules |
1516
| **[Module Configuration](/explanation/module-configuration.md)** | How modules handle user configuration and help registration through a setup skill |
1617

1718
## Design Patterns
1819

19-
| Topic | Description |
20-
|-------|-------------|
21-
| **[Progressive Disclosure](/explanation/progressive-disclosure.md)** | Four layers of context loading — from frontmatter through step files |
22-
| **[Subagent Patterns](/explanation/subagent-patterns.md)** | Six orchestration patterns for parallel and hierarchical work |
23-
| **[Skill Authoring Best Practices](/explanation/skill-authoring-best-practices.md)** | Core principles, common patterns, quality dimensions, and anti-patterns |
24-
| **[Scripts in Skills](/explanation/scripts-in-skills.md)** | Why deterministic scripts make skills faster, cheaper, and more reliable |
20+
| Topic | Description |
21+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
22+
| **[Progressive Disclosure](/explanation/progressive-disclosure.md)** | Four layers of context loading — from frontmatter through step files |
23+
| **[Subagent Patterns](/explanation/subagent-patterns.md)** | Six orchestration patterns for parallel and hierarchical work |
24+
| **[Skill Authoring Best Practices](/explanation/skill-authoring-best-practices.md)** | Core principles, common patterns, quality dimensions, and anti-patterns |
25+
| **[Scripts in Skills](/explanation/scripts-in-skills.md)** | Why deterministic scripts make skills faster, cheaper, and more reliable |
2526

2627
## Reference
2728

28-
| Resource | Description |
29-
|----------|-------------|
30-
| **[Builder Commands](/reference/builder-commands.md)** | All capabilities, modes, and phases for both builders |
29+
| Resource | Description |
30+
| -------------------------------------------------------- | ----------------------------------------------------- |
31+
| **[Builder Commands](/reference/builder-commands.md)** | All capabilities, modes, and phases for both builders |
3132
| **[Workflow Patterns](/reference/workflow-patterns.md)** | Skill types, structure patterns, and execution models |

0 commit comments

Comments
 (0)