bmad-method 4.27.5 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.bmad-core/agent-teams/team-all.yml +16 -0
- package/.bmad-core/agent-teams/team-fullstack.yml +26 -0
- package/.bmad-core/agent-teams/team-no-ui.yml +15 -0
- package/{bmad-core → .bmad-core}/agents/analyst.md +23 -30
- package/.bmad-core/agents/architect.md +66 -0
- package/.bmad-core/agents/bmad-master.md +104 -0
- package/.bmad-core/agents/bmad-orchestrator.md +81 -0
- package/.bmad-core/agents/dev.md +70 -0
- package/{bmad-core → .bmad-core}/agents/pm.md +24 -25
- package/{bmad-core → .bmad-core}/agents/po.md +24 -28
- package/.bmad-core/agents/qa.md +52 -0
- package/.bmad-core/agents/sm.md +55 -0
- package/.bmad-core/agents/ux-expert.md +66 -0
- package/{bmad-core → .bmad-core}/checklists/change-checklist.md +2 -2
- package/{bmad-core → .bmad-core}/checklists/story-draft-checklist.md +1 -1
- package/.bmad-core/data/bmad-kb.md +47 -0
- package/.bmad-core/schemas/agent-team-schema.yml +153 -0
- package/.bmad-core/tasks/advanced-elicitation.md +92 -0
- package/.bmad-core/tasks/brainstorming-techniques.md +238 -0
- package/.bmad-core/tasks/core-dump.md +74 -0
- package/{expansion-packs/bmad-creator-tools → .bmad-core}/tasks/create-agent.md +11 -9
- package/.bmad-core/tasks/create-doc.md +74 -0
- package/.bmad-core/tasks/create-expansion-pack.md +425 -0
- package/.bmad-core/tasks/create-next-story.md +206 -0
- package/.bmad-core/tasks/create-team.md +229 -0
- package/{bmad-core → .bmad-core}/tasks/doc-migration-task.md +9 -9
- package/{common → .bmad-core}/tasks/execute-checklist.md +6 -2
- package/.bmad-core/tasks/generate-ai-frontend-prompt.md +58 -0
- package/{bmad-core → .bmad-core}/tasks/index-docs.md +7 -3
- package/{bmad-core → .bmad-core}/tasks/shard-doc.md +7 -25
- package/.bmad-core/templates/agent-tmpl.md +58 -0
- package/.bmad-core/templates/architecture-tmpl.md +771 -0
- package/.bmad-core/templates/brownfield-architecture-tmpl.md +542 -0
- package/.bmad-core/templates/brownfield-prd-tmpl.md +240 -0
- package/.bmad-core/templates/competitor-analysis-tmpl.md +289 -0
- package/.bmad-core/templates/expansion-pack-plan-tmpl.md +91 -0
- package/.bmad-core/templates/front-end-architecture-tmpl.md +173 -0
- package/.bmad-core/templates/front-end-spec-tmpl.md +411 -0
- package/.bmad-core/templates/fullstack-architecture-tmpl.md +1016 -0
- package/.bmad-core/templates/market-research-tmpl.md +261 -0
- package/.bmad-core/templates/prd-tmpl.md +200 -0
- package/.bmad-core/templates/project-brief-tmpl.md +228 -0
- package/.bmad-core/templates/simple-project-prd-tmpl.md +461 -0
- package/.bmad-core/templates/story-tmpl.md +61 -0
- package/.bmad-core/templates/web-agent-startup-instructions-template.md +39 -0
- package/.bmad-core/utils/agent-switcher.ide.md +112 -0
- package/.bmad-core/utils/template-format.md +26 -0
- package/.bmad-core/utils/workflow-management.md +224 -0
- package/.bmad-core/web-bundles/agents/analyst.txt +1684 -0
- package/.bmad-core/web-bundles/agents/architect.txt +3584 -0
- package/.bmad-core/web-bundles/agents/bmad-master.txt +9491 -0
- package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +1466 -0
- package/{dist → .bmad-core/web-bundles}/agents/dev.txt +71 -179
- package/{dist → .bmad-core/web-bundles}/agents/pm.txt +1058 -624
- package/{dist → .bmad-core/web-bundles}/agents/po.txt +138 -337
- package/.bmad-core/web-bundles/agents/qa.txt +129 -0
- package/.bmad-core/web-bundles/agents/sm.txt +658 -0
- package/.bmad-core/web-bundles/agents/ux-expert.txt +1099 -0
- package/.bmad-core/web-bundles/teams/team-all.txt +10757 -0
- package/.bmad-core/web-bundles/teams/team-fullstack.txt +10109 -0
- package/.bmad-core/web-bundles/teams/team-no-ui.txt +8950 -0
- package/.bmad-core/workflows/brownfield-fullstack.yml +116 -0
- package/.bmad-core/workflows/brownfield-service.yml +117 -0
- package/.bmad-core/workflows/brownfield-ui.yml +127 -0
- package/{bmad-core/workflows/greenfield-fullstack.yaml → .bmad-core/workflows/greenfield-fullstack.yml} +77 -140
- package/.bmad-core/workflows/greenfield-service.yml +143 -0
- package/.bmad-core/workflows/greenfield-ui.yml +172 -0
- package/.claude/commands/analyst.md +63 -0
- package/.claude/commands/architect.md +70 -0
- package/.claude/commands/bmad-master.md +108 -0
- package/.claude/commands/bmad-orchestrator.md +85 -0
- package/.claude/commands/dev.md +74 -0
- package/.claude/commands/pm.md +63 -0
- package/.claude/commands/po.md +64 -0
- package/.claude/commands/qa.md +56 -0
- package/.claude/commands/sm.md +59 -0
- package/.claude/commands/ux-expert.md +70 -0
- package/.cursor/rules/analyst.mdc +77 -0
- package/.cursor/rules/architect.mdc +84 -0
- package/.cursor/rules/bmad-master.mdc +122 -0
- package/.cursor/rules/bmad-orchestrator.mdc +99 -0
- package/.cursor/rules/dev.mdc +88 -0
- package/.cursor/rules/pm.mdc +77 -0
- package/.cursor/rules/po.mdc +78 -0
- package/.cursor/rules/qa.mdc +70 -0
- package/.cursor/rules/sm.mdc +73 -0
- package/.cursor/rules/ux-expert.mdc +84 -0
- package/.roo/.roomodes +95 -0
- package/.roo/README.md +38 -0
- package/.vscode/extensions.json +6 -0
- package/.vscode/settings.json +75 -49
- package/.windsurf/rules/analyst.md +71 -0
- package/.windsurf/rules/architect.md +78 -0
- package/.windsurf/rules/bmad-master.md +116 -0
- package/.windsurf/rules/bmad-orchestrator.md +93 -0
- package/.windsurf/rules/dev.md +82 -0
- package/.windsurf/rules/pm.md +71 -0
- package/.windsurf/rules/po.md +72 -0
- package/.windsurf/rules/qa.md +64 -0
- package/.windsurf/rules/sm.md +67 -0
- package/.windsurf/rules/ux-expert.md +78 -0
- package/CHANGELOG.md +16 -452
- package/CONTRIBUTING.md +5 -168
- package/LICENSE +1 -1
- package/README.md +230 -77
- package/docs/bmad-workflow-guide.md +15 -19
- package/docs/claude-code-guide.md +119 -0
- package/docs/cursor-guide.md +127 -0
- package/docs/roo-code-guide.md +140 -0
- package/docs/sample-output/simple-fullstack-greenfield/prd.md +42 -0
- package/docs/versioning-and-releases.md +16 -8
- package/docs/versions.md +5 -4
- package/docs/windsurf-guide.md +127 -0
- package/expansion-packs/README.md +112 -2
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/README.md +9 -9
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/agents/infra-devops-platform.md +15 -15
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/checklists/infrastructure-checklist.md +1 -1
- package/expansion-packs/infrastructure-devops/manifest.yml +38 -0
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/review-infrastructure.md +4 -4
- package/expansion-packs/{bmad-infrastructure-devops → infrastructure-devops}/tasks/validate-infrastructure.md +4 -4
- package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +415 -0
- package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
- package/package.json +11 -19
- package/tools/bmad-npx-wrapper.js +1 -1
- package/tools/builders/web-builder.js +28 -563
- package/tools/cli.js +22 -55
- package/tools/installer/README.md +53 -3
- package/tools/installer/bin/bmad.js +56 -294
- package/tools/installer/config/install.config.yml +139 -0
- package/tools/installer/lib/config-loader.js +34 -198
- package/tools/installer/lib/file-manager.js +5 -123
- package/tools/installer/lib/ide-setup.js +189 -545
- package/tools/installer/lib/installer.js +55 -1136
- package/tools/installer/package-lock.json +3 -3
- package/tools/installer/package.json +4 -4
- package/tools/installer/templates/claude-commands.md +7 -0
- package/tools/installer/templates/cursor-rules.md +22 -0
- package/tools/installer/templates/windsurf-rules.md +22 -0
- package/tools/lib/dependency-resolver.js +22 -22
- package/tools/upgraders/v3-to-v4-upgrader.js +43 -35
- package/tools/version-bump.js +1 -1
- package/tools/yaml-format.js +2 -2
- package/.github/FUNDING.yaml +0 -15
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -32
- package/.github/ISSUE_TEMPLATE/feature_request.md +0 -22
- package/.prettierignore +0 -21
- package/.prettierrc +0 -23
- package/bmad-core/agent-teams/team-all.yaml +0 -14
- package/bmad-core/agent-teams/team-fullstack.yaml +0 -18
- package/bmad-core/agent-teams/team-ide-minimal.yaml +0 -10
- package/bmad-core/agent-teams/team-no-ui.yaml +0 -13
- package/bmad-core/agents/architect.md +0 -63
- package/bmad-core/agents/bmad-master.md +0 -110
- package/bmad-core/agents/bmad-orchestrator.md +0 -140
- package/bmad-core/agents/dev.md +0 -57
- package/bmad-core/agents/qa.md +0 -55
- package/bmad-core/agents/sm.md +0 -46
- package/bmad-core/agents/ux-expert.md +0 -54
- package/bmad-core/core-config.yaml +0 -25
- package/bmad-core/data/bmad-kb.md +0 -803
- package/bmad-core/data/brainstorming-techniques.md +0 -36
- package/bmad-core/data/elicitation-methods.md +0 -134
- package/bmad-core/tasks/advanced-elicitation.md +0 -117
- package/bmad-core/tasks/create-brownfield-story.md +0 -355
- package/bmad-core/tasks/create-next-story.md +0 -114
- package/bmad-core/tasks/create-workflow-plan.md +0 -289
- package/bmad-core/tasks/document-project.md +0 -317
- package/bmad-core/tasks/facilitate-brainstorming-session.md +0 -136
- package/bmad-core/tasks/generate-ai-frontend-prompt.md +0 -51
- package/bmad-core/tasks/kb-mode-interaction.md +0 -70
- package/bmad-core/tasks/review-story.md +0 -145
- package/bmad-core/tasks/update-workflow-plan.md +0 -248
- package/bmad-core/tasks/validate-next-story.md +0 -134
- package/bmad-core/templates/architecture-tmpl.yaml +0 -650
- package/bmad-core/templates/brainstorming-output-tmpl.yaml +0 -156
- package/bmad-core/templates/brownfield-architecture-tmpl.yaml +0 -476
- package/bmad-core/templates/brownfield-prd-tmpl.yaml +0 -280
- package/bmad-core/templates/competitor-analysis-tmpl.yaml +0 -293
- package/bmad-core/templates/front-end-architecture-tmpl.yaml +0 -206
- package/bmad-core/templates/front-end-spec-tmpl.yaml +0 -349
- package/bmad-core/templates/fullstack-architecture-tmpl.yaml +0 -805
- package/bmad-core/templates/market-research-tmpl.yaml +0 -252
- package/bmad-core/templates/prd-tmpl.yaml +0 -202
- package/bmad-core/templates/project-brief-tmpl.yaml +0 -221
- package/bmad-core/templates/story-tmpl.yaml +0 -137
- package/bmad-core/utils/plan-management.md +0 -219
- package/bmad-core/workflows/brownfield-fullstack.yaml +0 -297
- package/bmad-core/workflows/brownfield-service.yaml +0 -187
- package/bmad-core/workflows/brownfield-ui.yaml +0 -197
- package/bmad-core/workflows/greenfield-service.yaml +0 -206
- package/bmad-core/workflows/greenfield-ui.yaml +0 -235
- package/common/tasks/create-doc.md +0 -79
- package/common/utils/bmad-doc-template.md +0 -325
- package/common/utils/workflow-management.md +0 -69
- package/dist/agents/analyst.txt +0 -2849
- package/dist/agents/architect.txt +0 -3505
- package/dist/agents/bmad-master.txt +0 -9588
- package/dist/agents/bmad-orchestrator.txt +0 -2232
- package/dist/agents/qa.txt +0 -388
- package/dist/agents/sm.txt +0 -673
- package/dist/agents/ux-expert.txt +0 -987
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +0 -2401
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +0 -1635
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +0 -825
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +0 -11730
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +0 -2023
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +0 -2052
- package/dist/teams/team-all.txt +0 -11799
- package/dist/teams/team-fullstack.txt +0 -11129
- package/dist/teams/team-ide-minimal.txt +0 -4573
- package/dist/teams/team-no-ui.txt +0 -9684
- package/docs/GUIDING-PRINCIPLES.md +0 -91
- package/docs/agentic-tools/claude-code-guide.md +0 -19
- package/docs/agentic-tools/cline-guide.md +0 -16
- package/docs/agentic-tools/cursor-guide.md +0 -14
- package/docs/agentic-tools/gemini-cli-guide.md +0 -32
- package/docs/agentic-tools/github-copilot-guide.md +0 -42
- package/docs/agentic-tools/roo-code-guide.md +0 -15
- package/docs/agentic-tools/trae-guide.md +0 -14
- package/docs/agentic-tools/windsurf-guide.md +0 -14
- package/docs/core-architecture.md +0 -219
- package/docs/expansion-packs.md +0 -280
- package/docs/how-to-contribute-with-pull-requests.md +0 -158
- package/docs/template-markup-references.md +0 -86
- package/docs/user-guide.md +0 -1142
- package/docs/working-in-the-brownfield.md +0 -361
- package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +0 -13
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +0 -60
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +0 -68
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +0 -53
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +0 -201
- package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +0 -160
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +0 -7
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +0 -254
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +0 -651
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +0 -111
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +0 -216
- package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +0 -308
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +0 -613
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +0 -356
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +0 -343
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +0 -253
- package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +0 -484
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml +0 -183
- package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yaml +0 -175
- package/expansion-packs/bmad-creator-tools/README.md +0 -8
- package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +0 -55
- package/expansion-packs/bmad-creator-tools/config.yaml +0 -5
- package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +0 -1020
- package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +0 -178
- package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +0 -154
- package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +0 -120
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +0 -8
- package/expansion-packs/bmad-infrastructure-devops/data/bmad-kb.md +0 -308
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +0 -424
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +0 -629
- package/tools/bump-all-versions.js +0 -107
- package/tools/bump-core-version.js +0 -57
- package/tools/bump-expansion-version.js +0 -78
- package/tools/installer/config/ide-agent-config.yaml +0 -58
- package/tools/installer/config/install.config.yaml +0 -91
- package/tools/lib/yaml-utils.js +0 -29
- package/tools/md-assets/web-agent-startup-instructions.md +0 -39
- package/tools/update-expansion-version.js +0 -54
- /package/{bmad-core → .bmad-core}/checklists/architect-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/checklists/pm-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/checklists/po-master-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/checklists/story-dod-checklist.md +0 -0
- /package/{bmad-core → .bmad-core}/data/technical-preferences.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/brownfield-create-epic.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/brownfield-create-story.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/correct-course.md +0 -0
- /package/{bmad-core → .bmad-core}/tasks/create-deep-research-prompt.md +0 -0
- /package/.github/workflows/{release.yaml → release.yml} +0 -0
package/CONTRIBUTING.md
CHANGED
|
@@ -2,17 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
|
|
4
4
|
|
|
5
|
-
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
|
6
|
-
|
|
7
|
-
📋 **Before contributing**, please read our [Guiding Principles](docs/GUIDING-PRINCIPLES.md) to understand the BMad Method's core philosophy and architectural decisions.
|
|
8
|
-
|
|
9
5
|
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
|
10
6
|
|
|
11
|
-
💬 **Discord Community**: Join our [Discord server](https://discord.gg/g6ypHytrCB) for real-time discussions:
|
|
12
|
-
|
|
13
|
-
- **#general-dev** - Technical discussions, feature ideas, and development questions
|
|
14
|
-
- **#bugs-issues** - Bug reports and issue discussions
|
|
15
|
-
|
|
16
7
|
## Code of Conduct
|
|
17
8
|
|
|
18
9
|
By participating in this project, you agree to abide by our Code of Conduct. Please read it before participating.
|
|
@@ -21,96 +12,18 @@ By participating in this project, you agree to abide by our Code of Conduct. Ple
|
|
|
21
12
|
|
|
22
13
|
### Reporting Bugs
|
|
23
14
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
- Steps to reproduce
|
|
28
|
-
- Expected vs actual behavior
|
|
29
|
-
- Model/IDE/BMad version details
|
|
30
|
-
- Screenshots or links if applicable
|
|
31
|
-
3. **Consider discussing in Discord** (#bugs-issues channel) for quick help
|
|
32
|
-
4. **Indicate if you're working on a fix** to avoid duplicate efforts
|
|
15
|
+
- Check if the bug has already been reported in the Issues section
|
|
16
|
+
- Include detailed steps to reproduce the bug
|
|
17
|
+
- Include any relevant logs or screenshots
|
|
33
18
|
|
|
34
19
|
### Suggesting Features
|
|
35
20
|
|
|
36
|
-
|
|
37
|
-
2. **Check existing issues and discussions** to avoid duplicates
|
|
38
|
-
3. **Use the feature request template** when creating an issue - it will guide you through:
|
|
39
|
-
- Confirming Discord discussion
|
|
40
|
-
- Describing the problem it solves
|
|
41
|
-
- Explaining your solution
|
|
42
|
-
- Listing alternatives considered
|
|
43
|
-
4. **Be specific** about why this feature would benefit the BMad community
|
|
21
|
+
- Check if the feature has already been suggested in the Issues section, and consider using the discussions tab in GitHub also. Explain the feature in detail and why it would be valuable.
|
|
44
22
|
|
|
45
23
|
### Pull Request Process
|
|
46
24
|
|
|
47
|
-
⚠️ **Before starting work:**
|
|
48
|
-
|
|
49
|
-
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
|
|
50
|
-
2. **For features**: Ensure you've discussed in Discord (#general-dev) AND created a feature request issue
|
|
51
|
-
3. **For large changes**: Always open an issue first to discuss alignment
|
|
52
|
-
|
|
53
25
|
Please only propose small granular commits! If its large or significant, please discuss in the discussions tab and open up an issue first. I do not want you to waste your time on a potentially very large PR to have it rejected because it is not aligned or deviates from other planned changes. Communicate and lets work together to build and improve this great community project!
|
|
54
26
|
|
|
55
|
-
**Important**: All contributions must align with our [Guiding Principles](docs/GUIDING-PRINCIPLES.md). Key points:
|
|
56
|
-
|
|
57
|
-
- Keep dev agents lean - they need context for coding, not documentation
|
|
58
|
-
- Web/planning agents can be larger with more complex tasks
|
|
59
|
-
- Everything is natural language (markdown) - no code in core framework
|
|
60
|
-
- Use expansion packs for domain-specific features
|
|
61
|
-
|
|
62
|
-
#### Which Branch for Your PR?
|
|
63
|
-
|
|
64
|
-
**Submit to `next` branch** (most contributions):
|
|
65
|
-
|
|
66
|
-
- ✨ New features or agents
|
|
67
|
-
- 🎨 Enhancements to existing features
|
|
68
|
-
- 📚 Documentation updates
|
|
69
|
-
- ♻️ Code refactoring
|
|
70
|
-
- ⚡ Performance improvements
|
|
71
|
-
- 🧪 New tests
|
|
72
|
-
- 🎁 New expansion packs
|
|
73
|
-
|
|
74
|
-
**Submit to `main` branch** (critical only):
|
|
75
|
-
|
|
76
|
-
- 🚨 Critical bug fixes that break basic functionality
|
|
77
|
-
- 🔒 Security patches
|
|
78
|
-
- 📚 Fixing dangerously incorrect documentation
|
|
79
|
-
- 🐛 Bugs preventing installation or basic usage
|
|
80
|
-
|
|
81
|
-
**When in doubt, submit to `next`**. We'd rather test changes thoroughly before they hit stable.
|
|
82
|
-
|
|
83
|
-
#### PR Size Guidelines
|
|
84
|
-
|
|
85
|
-
- **Ideal PR size**: 200-400 lines of code changes
|
|
86
|
-
- **Maximum PR size**: 800 lines (excluding generated files)
|
|
87
|
-
- **One feature/fix per PR**: Each PR should address a single issue or add one feature
|
|
88
|
-
- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
|
|
89
|
-
- **Related changes**: Even related changes should be separate PRs if they deliver independent value
|
|
90
|
-
|
|
91
|
-
#### Breaking Down Large PRs
|
|
92
|
-
|
|
93
|
-
If your change exceeds 800 lines, use this checklist to split it:
|
|
94
|
-
|
|
95
|
-
- [ ] Can I separate the refactoring from the feature implementation?
|
|
96
|
-
- [ ] Can I introduce the new API/interface in one PR and implementation in another?
|
|
97
|
-
- [ ] Can I split by file or module?
|
|
98
|
-
- [ ] Can I create a base PR with shared utilities first?
|
|
99
|
-
- [ ] Can I separate test additions from implementation?
|
|
100
|
-
- [ ] Even if changes are related, can they deliver value independently?
|
|
101
|
-
- [ ] Can these changes be merged in any order without breaking things?
|
|
102
|
-
|
|
103
|
-
Example breakdown:
|
|
104
|
-
|
|
105
|
-
1. PR #1: Add utility functions and types (100 lines)
|
|
106
|
-
2. PR #2: Refactor existing code to use utilities (200 lines)
|
|
107
|
-
3. PR #3: Implement new feature using refactored code (300 lines)
|
|
108
|
-
4. PR #4: Add comprehensive tests (200 lines)
|
|
109
|
-
|
|
110
|
-
**Note**: PRs #1 and #4 could be submitted simultaneously since they deliver independent value and don't depend on each other's merge order.
|
|
111
|
-
|
|
112
|
-
#### Pull Request Steps
|
|
113
|
-
|
|
114
27
|
1. Fork the repository
|
|
115
28
|
2. Create a new branch (`git checkout -b feature/your-feature-name`)
|
|
116
29
|
3. Make your changes
|
|
@@ -119,85 +32,9 @@ Example breakdown:
|
|
|
119
32
|
6. Push to your branch (`git push origin feature/your-feature-name`)
|
|
120
33
|
7. Open a Pull Request against the main branch
|
|
121
34
|
|
|
122
|
-
## Issue Templates
|
|
123
|
-
|
|
124
|
-
We use GitHub issue templates to ensure all necessary information is provided:
|
|
125
|
-
|
|
126
|
-
- **Bug Reports**: Automatically guides you through providing reproduction steps, environment details, and expected behavior
|
|
127
|
-
- **Feature Requests**: Requires Discord discussion confirmation and asks for problem/solution descriptions
|
|
128
|
-
|
|
129
|
-
Using these templates helps maintainers understand and address your contribution faster.
|
|
130
|
-
|
|
131
|
-
## Pull Request Description Guidelines
|
|
132
|
-
|
|
133
|
-
Keep PR descriptions short and to the point following this template:
|
|
134
|
-
|
|
135
|
-
### PR Description Template
|
|
136
|
-
|
|
137
|
-
Keep your PR description concise and focused. Use this template:
|
|
138
|
-
|
|
139
|
-
```markdown
|
|
140
|
-
## What
|
|
141
|
-
|
|
142
|
-
[1-2 sentences describing WHAT changed]
|
|
143
|
-
|
|
144
|
-
## Why
|
|
145
|
-
|
|
146
|
-
[1-2 sentences explaining WHY this change is needed]
|
|
147
|
-
Fixes #[issue number] (if applicable)
|
|
148
|
-
|
|
149
|
-
## How
|
|
150
|
-
|
|
151
|
-
[2-3 bullets listing HOW you implemented it]
|
|
152
|
-
|
|
153
|
-
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
|
|
157
|
-
## Testing
|
|
158
|
-
|
|
159
|
-
[1-2 sentences on how you tested this]
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
**Maximum PR description length: 200 words** (excluding code examples if needed)
|
|
163
|
-
|
|
164
|
-
### Good vs Bad PR Descriptions
|
|
165
|
-
|
|
166
|
-
❌ **Bad Example:**
|
|
167
|
-
|
|
168
|
-
> This revolutionary PR introduces a paradigm-shifting enhancement to the system's architecture by implementing a state-of-the-art solution that leverages cutting-edge methodologies to optimize performance metrics and deliver unprecedented value to stakeholders through innovative approaches...
|
|
169
|
-
|
|
170
|
-
✅ **Good Example:**
|
|
171
|
-
|
|
172
|
-
> **What:** Added validation for agent dependency resolution
|
|
173
|
-
> **Why:** Build was failing silently when agents had circular dependencies
|
|
174
|
-
> **How:**
|
|
175
|
-
>
|
|
176
|
-
> - Added cycle detection in dependency-resolver.js
|
|
177
|
-
> - Throws clear error with dependency chain
|
|
178
|
-
> **Testing:** Tested with circular deps between 3 agents
|
|
179
|
-
|
|
180
35
|
## Commit Message Convention
|
|
181
36
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
- `feat:` New feature
|
|
185
|
-
- `fix:` Bug fix
|
|
186
|
-
- `docs:` Documentation only
|
|
187
|
-
- `refactor:` Code change that neither fixes a bug nor adds a feature
|
|
188
|
-
- `test:` Adding missing tests
|
|
189
|
-
- `chore:` Changes to build process or auxiliary tools
|
|
190
|
-
|
|
191
|
-
Keep commit messages under 72 characters.
|
|
192
|
-
|
|
193
|
-
### Atomic Commits
|
|
194
|
-
|
|
195
|
-
Each commit should represent one logical change:
|
|
196
|
-
|
|
197
|
-
- **Do:** One bug fix per commit
|
|
198
|
-
- **Do:** One feature addition per commit
|
|
199
|
-
- **Don't:** Mix refactoring with bug fixes
|
|
200
|
-
- **Don't:** Combine unrelated changes
|
|
37
|
+
PRs with a wall of AI Generated marketing hype that is unclear in what is being proposed will be closed and rejected. Your best change to contribute is with a small clear PR description explaining, what is the issue being solved or gap in the system being filled. Also explain how it leads to the core guiding principles of the project.
|
|
201
38
|
|
|
202
39
|
## Code Style
|
|
203
40
|
|
package/LICENSE
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
MIT License
|
|
2
2
|
|
|
3
|
-
Copyright (c) 2025 Brian AKA BMad AKA
|
|
3
|
+
Copyright (c) 2025 Brian AKA BMad AKA Bmad Code
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
6
|
of this software and associated documentation files (the "Software"), to deal
|
package/README.md
CHANGED
|
@@ -1,139 +1,292 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMAD-METHOD
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/bmad-method)
|
|
4
4
|
[](LICENSE)
|
|
5
|
-
[](https://discord.gg/
|
|
5
|
+
[](https://nodejs.org)
|
|
6
|
+
[](https://discord.gg/g6ypHytrCB)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
**AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team.
|
|
9
9
|
|
|
10
|
-
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
|
|
10
|
+
📺 **[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)** - V4 walkthrough and comprehensive guide coming soon!
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
⭐ **If you find this project helpful or useful, please give it a star!** It helps others discover BMAD-METHOD and you will be notified of updates!
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
## 🚀 Quick Start
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
### Fastest Start: Web UI (2 minutes) 🏃♂️
|
|
17
|
+
|
|
18
|
+
1. Copy `.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
19
|
+
2. Create a new Gemini Gem or CustomGPT
|
|
20
|
+
3. Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
21
|
+
4. Start chatting! Type `/help` to see available commands
|
|
22
|
+
|
|
23
|
+
### IDE Quick Start (5 minutes) 💻
|
|
24
|
+
|
|
25
|
+
**Prerequisites**: Install [Node.js](https://nodejs.org) (v14 or higher)
|
|
17
26
|
|
|
18
|
-
|
|
27
|
+
````bash
|
|
28
|
+
npx bmad-method install
|
|
29
|
+
# The installer will automatically detect your project state and guide you through:
|
|
30
|
+
# - Fresh installation or upgrade from v3
|
|
31
|
+
# - Full installation or single agent
|
|
32
|
+
# - Destination folder and IDE configuration
|
|
33
|
+
```text
|
|
34
|
+
|
|
35
|
+
This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
|
|
19
36
|
|
|
20
|
-
|
|
37
|
+
## 📋 Table of Contents
|
|
21
38
|
|
|
22
|
-
|
|
39
|
+
- [Overview](#overview)
|
|
40
|
+
- [Installation](#installation)
|
|
41
|
+
- [Available Agents](#available-agents)
|
|
42
|
+
- [Usage](#usage)
|
|
43
|
+
- [Project Structure](#project-structure)
|
|
44
|
+
- [Contributing](#contributing)
|
|
23
45
|
|
|
24
|
-
|
|
46
|
+
## Overview
|
|
25
47
|
|
|
26
|
-
|
|
48
|
+
BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) revolutionizes software development by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain and can collaborate to deliver complete software projects.
|
|
27
49
|
|
|
28
|
-
|
|
50
|
+
### Why BMAD?
|
|
29
51
|
|
|
30
|
-
|
|
52
|
+
- **🎯 Specialized Expertise**: Each agent is an expert in their specific role
|
|
53
|
+
- **🔄 True Agile Workflow**: Follows real Agile methodologies and best practices
|
|
54
|
+
- **📦 Modular Design**: Use one agent or an entire team
|
|
55
|
+
- **🛠️ IDE Integration**: Works seamlessly with Cursor, Claude Code, and Windsurf
|
|
56
|
+
- **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
|
|
31
57
|
|
|
32
|
-
|
|
58
|
+
## Installation
|
|
33
59
|
|
|
34
|
-
1
|
|
35
|
-
2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
|
|
60
|
+
### Method 1: Pre-Built Web Bundles (Fastest) 📦
|
|
36
61
|
|
|
37
|
-
|
|
62
|
+
For ChatGPT, Claude, or Gemini web interfaces:
|
|
38
63
|
|
|
39
|
-
|
|
64
|
+
1. Choose a bundle:
|
|
65
|
+
- **Recommended**: `.bmad-core/web-bundles/teams/team-fullstack.txt` (complete development team)
|
|
66
|
+
- Or pick from individual agents in `.bmad-core/web-bundles/agents/`
|
|
67
|
+
2. Upload to your AI platform (Gemini Gem, CustomGPT, or directly in chat)
|
|
68
|
+
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
69
|
+
4. Type `/help` to see available commands
|
|
40
70
|
|
|
41
|
-
|
|
42
|
-
- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
|
|
43
|
-
- **[See available AI agents](#available-agents)** → Specialized roles for your team
|
|
44
|
-
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
|
45
|
-
- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
|
|
46
|
-
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
|
|
47
|
-
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
|
48
|
-
- **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
|
|
71
|
+
### Method 2: CLI Installer (For IDEs) 🎯
|
|
49
72
|
|
|
50
|
-
|
|
73
|
+
**Prerequisites**: Install [Node.js](https://nodejs.org) v14+ first
|
|
51
74
|
|
|
52
|
-
|
|
75
|
+
Install directly into your project:
|
|
53
76
|
|
|
54
77
|
```bash
|
|
78
|
+
# Interactive installation (recommended)
|
|
55
79
|
npx bmad-method install
|
|
56
|
-
#
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
80
|
+
# The installer automatically detects your project state and guides you through:
|
|
81
|
+
# - Fresh installation or upgrade from v3
|
|
82
|
+
# - Installation type (full/single agent)
|
|
83
|
+
# - Destination directory
|
|
84
|
+
# - IDE configuration
|
|
85
|
+
|
|
86
|
+
# Or use command line options for fresh installations
|
|
87
|
+
npx bmad-method install --full --directory ./my-project --ide cursor
|
|
88
|
+
npx bmad-method install --agent pm --directory ./my-project --ide claude-code
|
|
89
|
+
````
|
|
90
|
+
|
|
91
|
+
**Supported IDEs:**
|
|
92
|
+
|
|
93
|
+
The BMad Method works with any IDE, but has built-in integration for:
|
|
94
|
+
|
|
95
|
+
- `cursor` - Cursor IDE with @agent commands
|
|
96
|
+
- `claude-code` - Claude Code with /agent commands
|
|
97
|
+
- `windsurf` - Windsurf with @agent commands
|
|
98
|
+
- `roo` - Roo Code with custom modes (see `.roomodes`)
|
|
99
|
+
- More coming soon - BUT ITS easy to use with ANY IDE!
|
|
100
|
+
|
|
101
|
+
## Available Agents
|
|
102
|
+
|
|
103
|
+
### Core Development Team
|
|
104
|
+
|
|
105
|
+
| Agent | Role | Specialty |
|
|
106
|
+
| ----------- | ------------------ | --------------------------------------------- |
|
|
107
|
+
| `analyst` | Business Analyst | market analysis, brainstorming, project brief |
|
|
108
|
+
| `pm` | Product Manager | Product strategy, roadmaps, PRDs |
|
|
109
|
+
| `architect` | Solution Architect | System design, technical architecture |
|
|
110
|
+
| `dev` | Developer | Code implementation across all technologies |
|
|
111
|
+
| `qa` | QA Specialist | Testing strategies, quality assurance |
|
|
112
|
+
| `ux-expert` | UX Designer | User experience, UI design, prototypes |
|
|
113
|
+
| `po` | Product Owner | Backlog management, story validation |
|
|
114
|
+
| `sm` | Scrum Master | Sprint planning, story creation |
|
|
60
115
|
|
|
61
|
-
|
|
116
|
+
### Meta Agents
|
|
62
117
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
-
|
|
66
|
-
-
|
|
118
|
+
| Agent | Role | Specialty |
|
|
119
|
+
| ------------------- | ---------------- | ------------------------------------------------------------------- |
|
|
120
|
+
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching, is part of every team bundle |
|
|
121
|
+
| `bmad-master` | Universal Expert | All capabilities without switching |
|
|
67
122
|
|
|
68
|
-
|
|
123
|
+
## Usage
|
|
69
124
|
|
|
70
|
-
|
|
125
|
+
### With IDE Integration
|
|
71
126
|
|
|
72
|
-
|
|
127
|
+
After installation with `--ide` flag:
|
|
73
128
|
|
|
74
|
-
|
|
129
|
+
````bash
|
|
130
|
+
# In Cursor
|
|
131
|
+
@pm Create a PRD for a task management app
|
|
132
|
+
|
|
133
|
+
# In Claude Code
|
|
134
|
+
/architect Design a microservices architecture
|
|
135
|
+
|
|
136
|
+
# In Windsurf
|
|
137
|
+
@dev Implement story 1.3
|
|
138
|
+
```text
|
|
139
|
+
|
|
140
|
+
### With Web UI (ChatGPT/Claude/Gemini)
|
|
141
|
+
|
|
142
|
+
After uploading a bundle you can ask /help of the agent to learn what it can do
|
|
143
|
+
|
|
144
|
+
### CLI Commands
|
|
75
145
|
|
|
76
146
|
```bash
|
|
147
|
+
# List all available agents
|
|
148
|
+
npx bmad-method list
|
|
149
|
+
|
|
150
|
+
# Install or update (automatically detects existing installations)
|
|
77
151
|
npx bmad-method install
|
|
78
|
-
# OR if you already have BMad installed:
|
|
79
|
-
git pull
|
|
80
|
-
npm run install:bmad
|
|
81
|
-
```
|
|
82
152
|
|
|
83
|
-
|
|
153
|
+
# Check installation status
|
|
154
|
+
npx bmad-method status
|
|
155
|
+
````
|
|
156
|
+
|
|
157
|
+
### Upgrading from V3 to V4
|
|
158
|
+
|
|
159
|
+
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
|
160
|
+
|
|
161
|
+
````bash
|
|
162
|
+
npx bmad-method install
|
|
163
|
+
# The installer will automatically detect your V3 installation and offer to upgrade
|
|
164
|
+
```text
|
|
165
|
+
|
|
166
|
+
The upgrade process will:
|
|
167
|
+
|
|
168
|
+
1. Create a backup of your V3 files in `.bmad-v3-backup/`
|
|
169
|
+
2. Install the new V4 `.bmad-core/` structure
|
|
170
|
+
3. Migrate your documents (PRD, Architecture, Stories, Epics)
|
|
171
|
+
4. Set up IDE integration for all V4 agents
|
|
172
|
+
5. Create an install manifest for future updates
|
|
173
|
+
|
|
174
|
+
After upgrading:
|
|
84
175
|
|
|
85
|
-
|
|
86
|
-
-
|
|
87
|
-
|
|
176
|
+
1. Review your documents in the `docs/` folder
|
|
177
|
+
2. Use `@bmad-master` agent to run the `doc-migration-task` to align your documents with V4 templates
|
|
178
|
+
3. If you have separate front-end and backend architecture docs, the migration task will help merge them into a unified `full-stack-architecture.md`
|
|
88
179
|
|
|
89
|
-
|
|
180
|
+
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/`.
|
|
90
181
|
|
|
91
|
-
|
|
182
|
+
## Teams & Workflows
|
|
92
183
|
|
|
93
|
-
###
|
|
184
|
+
### Pre-Configured Teams
|
|
94
185
|
|
|
95
|
-
|
|
96
|
-
2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
|
|
97
|
-
3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
|
98
|
-
4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
|
|
99
|
-
5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
|
|
100
|
-
6. **When to moved to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details
|
|
186
|
+
Save context by using specialized teams:
|
|
101
187
|
|
|
102
|
-
|
|
188
|
+
- **Team All**: Complete Agile team with all 10 agents
|
|
189
|
+
- **Team Fullstack**: Frontend + Backend development focus
|
|
190
|
+
- **Team No-UI**: Backend/API development without UX
|
|
191
|
+
|
|
192
|
+
### Workflows
|
|
193
|
+
|
|
194
|
+
Structured approaches for different scenarios:
|
|
195
|
+
|
|
196
|
+
- **Greenfield**: Starting new projects (fullstack/service/UI)
|
|
197
|
+
- **Brownfield**: Enhancing existing projects
|
|
198
|
+
- **Simple**: Quick prototypes and MVPs
|
|
199
|
+
- **Complex**: Enterprise and large-scale projects
|
|
200
|
+
|
|
201
|
+
## Project Structure
|
|
202
|
+
|
|
203
|
+
```plaintext
|
|
204
|
+
.bmad-core/
|
|
205
|
+
├── agents/ # Individual agent definitions
|
|
206
|
+
├── agent-teams/ # Team configurations
|
|
207
|
+
├── workflows/ # Development workflows
|
|
208
|
+
├── templates/ # Document templates (PRD, Architecture, etc.)
|
|
209
|
+
├── tasks/ # Reusable task definitions
|
|
210
|
+
├── checklists/ # Quality checklists
|
|
211
|
+
├── data/ # Knowledge base
|
|
212
|
+
└── web-bundles/ # Pre-built bundles
|
|
213
|
+
|
|
214
|
+
tools/
|
|
215
|
+
├── cli.js # Build tool
|
|
216
|
+
├── installer/ # NPX installer
|
|
217
|
+
└── lib/ # Build utilities
|
|
218
|
+
|
|
219
|
+
expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.)
|
|
220
|
+
````
|
|
221
|
+
|
|
222
|
+
## Advanced Features
|
|
223
|
+
|
|
224
|
+
### Dynamic Dependencies
|
|
225
|
+
|
|
226
|
+
Each agent only loads the resources it needs, keeping context windows lean.
|
|
227
|
+
|
|
228
|
+
### Template System
|
|
229
|
+
|
|
230
|
+
Rich templates for all document types:
|
|
231
|
+
|
|
232
|
+
- Product Requirements (PRD)
|
|
233
|
+
- Architecture Documents
|
|
234
|
+
- User Stories
|
|
235
|
+
- Test Plans
|
|
236
|
+
- And more...
|
|
237
|
+
|
|
238
|
+
### Slash Star Commands
|
|
239
|
+
|
|
240
|
+
Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
|
|
241
|
+
|
|
242
|
+
## Contributing
|
|
243
|
+
|
|
244
|
+
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
245
|
+
|
|
246
|
+
### Development Setup
|
|
103
247
|
|
|
104
248
|
```bash
|
|
105
249
|
git clone https://github.com/bmadcode/bmad-method.git
|
|
106
|
-
|
|
250
|
+
cd bmad-method
|
|
251
|
+
npm install
|
|
107
252
|
```
|
|
108
253
|
|
|
109
|
-
##
|
|
254
|
+
## Documentation & Guides
|
|
110
255
|
|
|
111
|
-
|
|
256
|
+
### Workflow Guides
|
|
112
257
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
-
|
|
118
|
-
- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
|
|
119
|
-
- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
|
|
120
|
-
- [IDE Specific Guides available in this folder](docs/agentic-tools/)
|
|
258
|
+
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
|
259
|
+
- 🎯 [Cursor Guide](docs/cursor-guide.md) - Complete workflow for Cursor users
|
|
260
|
+
- 🤖 [Claude Code Guide](docs/claude-code-guide.md) - Complete workflow for Claude Code users
|
|
261
|
+
- 🌊 [Windsurf Guide](docs/windsurf-guide.md) - Complete workflow for Windsurf users
|
|
262
|
+
- 🦘 [Roo Code Guide](docs/roo-code-guide.md) - Complete workflow for Roo Code users
|
|
121
263
|
|
|
122
264
|
## Support
|
|
123
265
|
|
|
124
266
|
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
|
267
|
+
- 📖 [Documentation](docs/)
|
|
125
268
|
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
|
126
269
|
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
|
127
270
|
|
|
128
|
-
##
|
|
271
|
+
## License
|
|
129
272
|
|
|
130
|
-
|
|
273
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
131
274
|
|
|
132
|
-
|
|
275
|
+
## Version History
|
|
133
276
|
|
|
134
|
-
|
|
277
|
+
- **Current**: [v4.0.0](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
|
278
|
+
- **Previous Versions**:
|
|
279
|
+
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
|
|
280
|
+
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
|
|
281
|
+
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
|
|
135
282
|
|
|
136
|
-
|
|
283
|
+
See [versions.md](docs/versions.md) for detailed version history and migration guides.
|
|
284
|
+
|
|
285
|
+
## Author
|
|
286
|
+
|
|
287
|
+
Created by Brian (BMad) Madison
|
|
288
|
+
|
|
289
|
+
---
|
|
137
290
|
|
|
138
291
|
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
|
139
292
|
|