bmad-method 4.2.0 → 4.4.1

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.
Files changed (176) hide show
  1. package/.claude/commands/analyst.md +14 -20
  2. package/.claude/commands/architect.md +15 -20
  3. package/.claude/commands/bmad-master.md +18 -26
  4. package/.claude/commands/bmad-orchestrator.md +80 -33
  5. package/.claude/commands/dev.md +5 -4
  6. package/.claude/commands/pm.md +11 -16
  7. package/.claude/commands/sm.md +20 -25
  8. package/.cursor/rules/analyst.mdc +13 -19
  9. package/.cursor/rules/architect.mdc +14 -19
  10. package/.cursor/rules/bmad-master.mdc +18 -26
  11. package/.cursor/rules/bmad-orchestrator.mdc +80 -33
  12. package/.cursor/rules/dev.mdc +5 -4
  13. package/.cursor/rules/pm.mdc +11 -16
  14. package/.cursor/rules/sm.mdc +19 -24
  15. package/.releaserc.json +2 -1
  16. package/.roo/README.md +0 -11
  17. package/.vscode/settings.json +4 -0
  18. package/.windsurf/rules/analyst.md +13 -19
  19. package/.windsurf/rules/architect.md +14 -19
  20. package/.windsurf/rules/bmad-master.md +18 -26
  21. package/.windsurf/rules/bmad-orchestrator.md +80 -33
  22. package/.windsurf/rules/dev.md +5 -4
  23. package/.windsurf/rules/pm.md +11 -16
  24. package/.windsurf/rules/sm.md +19 -24
  25. package/CHANGELOG.md +126 -2
  26. package/CONTRIBUTING.md +2 -0
  27. package/README.md +20 -2
  28. package/{.bmad-core → bmad-core}/agent-teams/team-all.yml +1 -3
  29. package/bmad-core/agent-teams/team-fullstack.yml +18 -0
  30. package/{.bmad-core → bmad-core}/agent-teams/team-no-ui.yml +0 -2
  31. package/{.bmad-core → bmad-core}/agents/analyst.md +14 -20
  32. package/{.bmad-core → bmad-core}/agents/architect.md +15 -20
  33. package/{.bmad-core → bmad-core}/agents/bmad-master.md +18 -26
  34. package/bmad-core/agents/bmad-orchestrator.md +128 -0
  35. package/{.bmad-core → bmad-core}/agents/dev.md +5 -4
  36. package/{.bmad-core → bmad-core}/agents/pm.md +11 -16
  37. package/{.bmad-core → bmad-core}/agents/qa.md +11 -17
  38. package/bmad-core/agents/sm.md +55 -0
  39. package/{.bmad-core → bmad-core}/agents/ux-expert.md +14 -20
  40. package/bmad-core/bmad-core-config.yml +60 -0
  41. package/bmad-core/data/bmad-kb.md +47 -0
  42. package/bmad-core/tasks/doc-migration-task.md +143 -0
  43. package/bmad-core/tasks/document-project.md +389 -0
  44. package/bmad-core/tasks/generate-ai-frontend-prompt.md +51 -0
  45. package/{.bmad-core → bmad-core}/tasks/index-docs.md +8 -3
  46. package/{.bmad-core → bmad-core}/tasks/shard-doc.md +5 -3
  47. package/{.bmad-core → bmad-core}/templates/architecture-tmpl.md +16 -13
  48. package/{.bmad-core → bmad-core}/templates/brownfield-architecture-tmpl.md +6 -6
  49. package/{.bmad-core → bmad-core}/templates/front-end-spec-tmpl.md +6 -6
  50. package/{.bmad-core → bmad-core}/templates/fullstack-architecture-tmpl.md +85 -103
  51. package/{.bmad-core → bmad-core}/templates/prd-tmpl.md +1 -1
  52. package/bmad-core/templates/simple-project-prd-tmpl.md +461 -0
  53. package/{.bmad-core → bmad-core}/templates/story-tmpl.md +2 -2
  54. package/{.bmad-core → bmad-core}/utils/agent-switcher.ide.md +6 -6
  55. package/{.bmad-core → bmad-core}/utils/workflow-management.md +14 -15
  56. package/{.bmad-core → bmad-core}/web-bundles/agents/analyst.txt +26 -21
  57. package/{.bmad-core → bmad-core}/web-bundles/agents/architect.txt +608 -236
  58. package/{.bmad-core → bmad-core}/web-bundles/agents/bmad-master.txt +467 -1049
  59. package/bmad-core/web-bundles/agents/bmad-orchestrator.txt +647 -0
  60. package/{.bmad-core → bmad-core}/web-bundles/agents/dev.txt +5 -4
  61. package/{.bmad-core → bmad-core}/web-bundles/agents/pm.txt +477 -18
  62. package/{.bmad-core → bmad-core}/web-bundles/agents/po.txt +3 -3
  63. package/{.bmad-core → bmad-core}/web-bundles/agents/qa.txt +11 -17
  64. package/{.bmad-core → bmad-core}/web-bundles/agents/sm.txt +22 -27
  65. package/{.bmad-core → bmad-core}/web-bundles/agents/ux-expert.txt +57 -70
  66. package/{.bmad-core → bmad-core}/workflows/greenfield-fullstack.yml +3 -3
  67. package/{.bmad-core → creator-tools}/tasks/create-agent.md +10 -12
  68. package/{.bmad-core/tasks/create-expansion-pack.md → creator-tools/tasks/generate-expansion-pack.md} +8 -6
  69. package/docs/bmad-workflow-guide.md +161 -0
  70. package/docs/claude-code-guide.md +119 -0
  71. package/docs/core-architecture.md +213 -0
  72. package/docs/cursor-guide.md +127 -0
  73. package/docs/how-to-contribute-with-pull-requests.md +141 -0
  74. package/docs/roo-code-guide.md +140 -0
  75. package/docs/user-guide.md +1044 -0
  76. package/docs/versioning-and-releases.md +4 -4
  77. package/docs/windsurf-guide.md +127 -0
  78. package/expansion-packs/README.md +1 -111
  79. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/team-game-dev.yml +12 -0
  80. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +58 -0
  81. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +66 -0
  82. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +51 -0
  83. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-design-checklist.md +201 -0
  84. package/expansion-packs/bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md +160 -0
  85. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +254 -0
  86. package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +631 -0
  87. package/expansion-packs/bmad-2d-phaser-game-dev/manifest.yml +45 -0
  88. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md +111 -0
  89. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +216 -0
  90. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md +308 -0
  91. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md +560 -0
  92. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md +345 -0
  93. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md +331 -0
  94. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.md +235 -0
  95. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md +451 -0
  96. package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/agents/game-designer.txt +1758 -0
  97. package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/agents/game-developer.txt +1444 -0
  98. package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/agents/game-sm.txt +674 -0
  99. package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/team-game-dev.txt +4395 -0
  100. package/expansion-packs/bmad-2d-phaser-game-dev/web-bundles/teams/team-game-dev.txt +4395 -0
  101. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yml +183 -0
  102. package/expansion-packs/bmad-2d-phaser-game-dev/workflows/game-prototype.yml +175 -0
  103. package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/README.md +5 -5
  104. package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/agents/infra-devops-platform.md +3 -3
  105. package/expansion-packs/bmad-infrastructure-devops/manifest.yml +23 -0
  106. package/expansion-packs/bmad-infrastructure-devops/tasks/create-doc.md +74 -0
  107. package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
  108. package/expansion-packs/bmad-infrastructure-devops/web-bundles/agents/infra-devops-platform.txt +2021 -0
  109. package/package.json +20 -14
  110. package/tools/builders/web-builder.js +207 -17
  111. package/tools/cli.js +55 -7
  112. package/tools/installer/README.md +2 -2
  113. package/tools/installer/bin/bmad.js +107 -28
  114. package/tools/installer/config/install.config.yml +43 -43
  115. package/tools/installer/lib/config-loader.js +39 -2
  116. package/tools/installer/lib/file-manager.js +20 -3
  117. package/tools/installer/lib/ide-setup.js +11 -1
  118. package/tools/installer/lib/installer.js +275 -29
  119. package/tools/installer/package-lock.json +538 -336
  120. package/tools/installer/package.json +8 -8
  121. package/tools/lib/dependency-resolver.js +2 -2
  122. package/tools/semantic-release-sync-installer.js +31 -0
  123. package/tools/sync-installer-version.js +34 -0
  124. package/tools/upgraders/v3-to-v4-upgrader.js +18 -13
  125. package/tools/version-bump.js +33 -26
  126. package/tools/yaml-format.js +54 -25
  127. package/.bmad-core/agent-teams/team-fullstack.yml +0 -26
  128. package/.bmad-core/agents/bmad-orchestrator.md +0 -81
  129. package/.bmad-core/agents/sm.md +0 -60
  130. package/.bmad-core/data/bmad-kb.md +0 -36
  131. package/.bmad-core/schemas/agent-team-schema.yml +0 -153
  132. package/.bmad-core/tasks/create-team.md +0 -229
  133. package/.bmad-core/tasks/doc-migration-task.md +0 -198
  134. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +0 -58
  135. package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +0 -1455
  136. package/.bmad-core/web-bundles/teams/team-all.txt +0 -10315
  137. package/.bmad-core/web-bundles/teams/team-fullstack.txt +0 -9663
  138. package/.bmad-core/web-bundles/teams/team-no-ui.txt +0 -8504
  139. package/.claude/settings.local.json +0 -22
  140. package/expansion-packs/infrastructure-devops/manifest.yml +0 -38
  141. /package/{.bmad-core → bmad-core}/agents/po.md +0 -0
  142. /package/{.bmad-core → bmad-core}/checklists/architect-checklist.md +0 -0
  143. /package/{.bmad-core → bmad-core}/checklists/change-checklist.md +0 -0
  144. /package/{.bmad-core → bmad-core}/checklists/pm-checklist.md +0 -0
  145. /package/{.bmad-core → bmad-core}/checklists/po-master-checklist.md +0 -0
  146. /package/{.bmad-core → bmad-core}/checklists/story-dod-checklist.md +0 -0
  147. /package/{.bmad-core → bmad-core}/checklists/story-draft-checklist.md +0 -0
  148. /package/{.bmad-core → bmad-core}/data/technical-preferences.md +0 -0
  149. /package/{.bmad-core → bmad-core}/tasks/advanced-elicitation.md +0 -0
  150. /package/{.bmad-core → bmad-core}/tasks/brainstorming-techniques.md +0 -0
  151. /package/{.bmad-core → bmad-core}/tasks/brownfield-create-epic.md +0 -0
  152. /package/{.bmad-core → bmad-core}/tasks/brownfield-create-story.md +0 -0
  153. /package/{.bmad-core → bmad-core}/tasks/core-dump.md +0 -0
  154. /package/{.bmad-core → bmad-core}/tasks/correct-course.md +0 -0
  155. /package/{.bmad-core → bmad-core}/tasks/create-deep-research-prompt.md +0 -0
  156. /package/{.bmad-core → bmad-core}/tasks/create-doc.md +0 -0
  157. /package/{.bmad-core → bmad-core}/tasks/create-next-story.md +0 -0
  158. /package/{.bmad-core → bmad-core}/tasks/execute-checklist.md +0 -0
  159. /package/{.bmad-core → bmad-core}/templates/agent-tmpl.md +0 -0
  160. /package/{.bmad-core → bmad-core}/templates/brownfield-prd-tmpl.md +0 -0
  161. /package/{.bmad-core → bmad-core}/templates/competitor-analysis-tmpl.md +0 -0
  162. /package/{.bmad-core → bmad-core}/templates/expansion-pack-plan-tmpl.md +0 -0
  163. /package/{.bmad-core → bmad-core}/templates/front-end-architecture-tmpl.md +0 -0
  164. /package/{.bmad-core → bmad-core}/templates/market-research-tmpl.md +0 -0
  165. /package/{.bmad-core → bmad-core}/templates/project-brief-tmpl.md +0 -0
  166. /package/{.bmad-core → bmad-core}/templates/web-agent-startup-instructions-template.md +0 -0
  167. /package/{.bmad-core → bmad-core}/utils/template-format.md +0 -0
  168. /package/{.bmad-core → bmad-core}/workflows/brownfield-fullstack.yml +0 -0
  169. /package/{.bmad-core → bmad-core}/workflows/brownfield-service.yml +0 -0
  170. /package/{.bmad-core → bmad-core}/workflows/brownfield-ui.yml +0 -0
  171. /package/{.bmad-core → bmad-core}/workflows/greenfield-service.yml +0 -0
  172. /package/{.bmad-core → bmad-core}/workflows/greenfield-ui.yml +0 -0
  173. /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/checklists/infrastructure-checklist.md +0 -0
  174. /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/tasks/review-infrastructure.md +0 -0
  175. /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/tasks/validate-infrastructure.md +0 -0
  176. /package/expansion-packs/{infrastructure-devops → bmad-infrastructure-devops}/templates/infrastructure-architecture-tmpl.md +0 -0
@@ -0,0 +1,119 @@
1
+ # BMAD Method Guide for Claude Code
2
+
3
+ This guide walks you through the complete BMAD workflow using Claude Code as your AI-powered IDE.
4
+
5
+ ## Step 1: Install BMAD in Your Project
6
+
7
+ 1. Navigate to your project directory
8
+ 2. Run the BMAD installer:
9
+ ```bash
10
+ npx bmad-method install
11
+ ```
12
+ 3. When prompted:
13
+ - **Installation Type**: Choose "Complete installation (recommended)"
14
+ - **IDE**: Select "Claude Code"
15
+
16
+ This creates a `.bmad-core` folder with all agents and a `.claude/commands` folder with agent commands.
17
+
18
+ ## Step 2: Set Up Team Fullstack in Gemini
19
+
20
+ For ideation and planning, use Google's Gemini with the team-fullstack configuration:
21
+
22
+ 1. Open [Google AI Studio (Gemini)](https://aistudio.google.com/)
23
+ 2. Create a new chat
24
+ 3. Copy the contents of `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
25
+ 4. Paste this content into Gemini to set up the team
26
+
27
+ ### Gemini Planning Phase
28
+
29
+ In Gemini, ask the BMAD team to help you:
30
+
31
+ - **Ideate** your project concept
32
+ - **Brainstorm** features and requirements
33
+ - **Create a PRD** (Product Requirements Document)
34
+ - **Design the architecture**
35
+
36
+ Ask questions like:
37
+
38
+ - "Help me brainstorm a [type of application] that does [core functionality]"
39
+ - "Create a comprehensive PRD for this concept"
40
+ - "Design the technical architecture for this system"
41
+
42
+ Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
43
+
44
+ - `docs/prd.md`
45
+ - `docs/architecture.md`
46
+
47
+ ## Step 3: Back to Claude Code - Document Sharding
48
+
49
+ Once you have your PRD and architecture documents in the `docs/` folder:
50
+
51
+ 1. **Start a new chat in Claude Code**
52
+ 2. **Load the bmad-master agent**: Type `/bmad-master`
53
+ 3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
54
+ 4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
55
+
56
+ This creates organized folders:
57
+
58
+ - `docs/prd/` - Contains broken down PRD sections
59
+ - `docs/architecture/` - Contains broken down architecture sections
60
+
61
+ ## Step 4: Story Development Cycle
62
+
63
+ Now begin the iterative development cycle:
64
+
65
+ ### Create Stories (Scrum Master)
66
+
67
+ 1. **Start a new chat**
68
+ 2. **Load SM agent**: Type `/sm`
69
+ 3. **Create story**: Type `*create` (this runs the create-next-story task)
70
+ 4. **Review the generated story**
71
+ 5. **If approved**: Set story status to "Approved" in the story file
72
+
73
+ ### Implement Stories (Developer)
74
+
75
+ 1. **Start a new chat**
76
+ 2. **Load Dev agent**: Type `/dev`
77
+ 3. **The agent will ask which story to implement**
78
+ 4. **Follow the development tasks** the agent provides
79
+ 5. **When story is complete**: Mark status as "Done"
80
+
81
+ ### Repeat the Cycle
82
+
83
+ 1. **Start a new chat with SM agent** (`/sm`)
84
+ 2. **Create next story**: Type `*create`
85
+ 3. **Review and approve**
86
+ 4. **Start new chat with Dev agent** (`/dev`)
87
+ 5. **Implement the story**
88
+ 6. **Repeat until project complete**
89
+
90
+ ## Available Commands in Claude Code
91
+
92
+ All BMAD agents are available as Claude Code commands:
93
+
94
+ - `/bmad-master` - Universal task executor
95
+ - `/sm` - Scrum Master for story creation
96
+ - `/dev` - Full-stack developer for implementation
97
+ - `/architect` - Solution architect for design
98
+ - `/pm` - Product manager for planning
99
+ - `/analyst` - Business analyst for requirements
100
+ - `/qa` - QA specialist for testing
101
+ - `/po` - Product owner for prioritization
102
+ - `/ux-expert` - UX specialist for design
103
+
104
+ ## Key Workflow Principles
105
+
106
+ 1. **Always start new chats** when switching agents to avoid context confusion
107
+ 2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
108
+ 3. **Use bmad-master for document management** (sharding, templates, etc.)
109
+ 4. **Follow the SM → Dev cycle** for consistent story development
110
+ 5. **Review and approve stories** before implementation begins
111
+
112
+ ## Tips for Success
113
+
114
+ - **Keep chats focused**: Each chat should have one agent and one primary task
115
+ - **Use \*help command**: Every agent supports `*help` to see available commands
116
+ - **Review generated content**: Always review and approve stories before marking them ready
117
+ - **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
118
+
119
+ This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
@@ -0,0 +1,213 @@
1
+ # BMAD Method: Core Architecture
2
+
3
+ This document serves as the definitive source of truth for the BMAD-Method's architecture. It is designed to be understood by both human developers and the AI agents that operate within the framework.
4
+
5
+ ## 1. Overview
6
+
7
+ The BMAD-Method is an AI-Powered Agile Development Framework designed to transform software development by providing specialized AI agents for every role in a complete Agile team. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex software development tasks in a predictable, high-quality manner.
8
+
9
+ The system facilitates a full development lifecycle:
10
+
11
+ 1. **Ideation & Planning**: Brainstorming, market research, and creating project briefs.
12
+ 2. **Architecture & Design**: Defining system architecture and UI/UX specifications.
13
+ 3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
14
+
15
+ ## 2. System Architecture Diagram
16
+
17
+ The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
18
+
19
+ ````mermaid
20
+ graph TD
21
+ subgraph BMAD Method Project
22
+ subgraph Core Framework
23
+ A["bmad-core"]
24
+ A --> B["agents"]
25
+ A --> C["agent-teams"]
26
+ A --> D["workflows"]
27
+ A --> E["templates"]
28
+ A --> F["tasks"]
29
+ A --> G["checklists"]
30
+ A --> H["data (KB)"]
31
+ end
32
+
33
+ subgraph Tooling
34
+ I["tools/builders/web-builder.js"]
35
+ end
36
+
37
+ subgraph Outputs
38
+ J[".bmad-core/web-bundles"]
39
+ end
40
+
41
+ B -- defines dependencies for --> E
42
+ B -- defines dependencies for --> F
43
+ B -- defines dependencies for --> G
44
+ B -- defines dependencies for --> H
45
+
46
+ C -- bundles --> B
47
+ I -- reads from --> A
48
+ I -- creates --> J
49
+ end
50
+
51
+ subgraph Target Environments
52
+ K["IDE (Cursor, VS Code, etc.)"]
53
+ L["Web UI (Gemini, ChatGPT)"]
54
+ end
55
+
56
+ B --> K
57
+ J --> L
58
+
59
+ style A fill:#1a73e8,color:#fff
60
+ style I fill:#f9ab00,color:#fff
61
+ style J fill:#34a853,color:#fff
62
+ ```text
63
+
64
+ ## 3. Core Components
65
+
66
+ The `.bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
67
+
68
+ ### 3.1. Agents (`.bmad-core/agents/`)
69
+
70
+ - **Purpose**: These are the foundational building blocks of the system. Each markdown file (e.g., `bmad-master.md`, `pm.md`, `dev.md`) defines the persona, capabilities, and dependencies of a single AI agent.
71
+ - **Structure**: An agent file contains a YAML header that specifies its role, persona, dependencies, and startup instructions. These dependencies are lists of tasks, templates, checklists, and data files that the agent is allowed to use.
72
+ - **Startup Instructions**: Agents can include startup sequences that load project-specific documentation from the `docs/` folder, such as coding standards, API specifications, or project structure documents. This provides immediate project context upon activation.
73
+ - **Document Integration**: Agents can reference and load documents from the project's `docs/` folder as part of tasks, workflows, or startup sequences. Users can also drag documents directly into chat interfaces to provide additional context.
74
+ - **Example**: The `bmad-master` agent lists its dependencies, which tells the build tool which files to include in a web bundle and informs the agent of its own capabilities.
75
+
76
+ ### 3.2. Agent Teams (`.bmad-core/agent-teams/`)
77
+
78
+ - **Purpose**: Team files (e.g., `team-all.yml`) define collections of agents and workflows that are bundled together for a specific purpose, like "full-stack development" or "backend-only". This creates a larger, pre-packaged context for web UI environments.
79
+ - **Structure**: A team file lists the agents to include. It can use wildcards, such as `"*"` to include all agents. This allows for the creation of comprehensive bundles like `team-all`.
80
+
81
+ ### 3.3. Workflows (`.bmad-core/workflows/`)
82
+
83
+ - **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.yml`) that define a prescribed sequence of steps and agent interactions for a specific project type. They act as a strategic guide for the user and the `bmad-orchestrator` agent.
84
+ - **Structure**: A workflow defines sequences for both complex and simple projects, lists the agents involved at each step, the artifacts they create, and the conditions for moving from one step to the next. It often includes a Mermaid diagram for visualization.
85
+
86
+ ### 3.4. Reusable Resources (`templates`, `tasks`, `checklists`, `data`)
87
+
88
+ - **Purpose**: These folders house the modular components that are dynamically loaded by agents based on their dependencies.
89
+ - **`templates/`**: Contains markdown templates for common documents like PRDs, architecture specifications, and user stories.
90
+ - **`tasks/`**: Defines the instructions for carrying out specific, repeatable actions like "shard-doc" or "create-next-story".
91
+ - **`checklists/`**: Provides quality assurance checklists for agents like the Product Owner (`po`) or Architect.
92
+ - **`data/`**: Contains the core knowledge base (`bmad-kb.md`), technical preferences (`technical-preferences.md`), and other key data files.
93
+
94
+ #### 3.4.1. Template Processing System
95
+
96
+ A key architectural principle of BMAD is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
97
+
98
+ The BMAD framework employs a sophisticated template processing system orchestrated by three key components:
99
+
100
+ - **`template-format.md`** (`.bmad-core/utils/`): Defines the foundational markup language used throughout all BMAD templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
101
+
102
+ - **`create-doc.md`** (`.bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
103
+
104
+ - **`advanced-elicitation.md`** (`.bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
105
+
106
+ The system maintains a clean separation of concerns: template markup is processed internally by AI agents but never exposed to users, while providing sophisticated AI processing capabilities through embedded intelligence within the templates themselves.
107
+
108
+ #### 3.4.2. Technical Preferences System
109
+
110
+ BMAD includes a personalization layer through the `technical-preferences.md` file in `.bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
111
+
112
+ **Purpose and Benefits:**
113
+ - **Consistency**: Ensures all agents reference the same technical preferences
114
+ - **Efficiency**: Eliminates the need to repeatedly specify preferred technologies
115
+ - **Personalization**: Agents provide recommendations aligned with user preferences
116
+ - **Learning**: Captures lessons learned and preferences that evolve over time
117
+
118
+ **Content Structure:**
119
+ The file typically includes preferred technology stacks, design patterns, external services, coding standards, and anti-patterns to avoid. Agents automatically reference this file during planning and development to provide contextually appropriate suggestions.
120
+
121
+ **Integration Points:**
122
+ - Templates can reference technical preferences during document generation
123
+ - Agents suggest preferred technologies when appropriate for project requirements
124
+ - When preferences don't fit project needs, agents explain alternatives
125
+ - Web bundles can include preferences content for consistent behavior across platforms
126
+
127
+ **Evolution Over Time:**
128
+ Users are encouraged to continuously update this file with discoveries from projects, adding both positive preferences and technologies to avoid, creating a personalized knowledge base that improves agent recommendations over time.
129
+
130
+ ## 4. The Build & Delivery Process
131
+
132
+ The framework is designed for two primary environments: local IDEs and web-based AI chat interfaces. The `web-builder.js` script is the key to supporting the latter.
133
+
134
+ ### 4.1. Web Builder (`tools/builders/web-builder.js`)
135
+
136
+ - **Purpose**: This Node.js script is responsible for creating the `.txt` bundles found in `.bmad-core/web-bundles/`.
137
+ - **Process**:
138
+ 1. **Resolves Dependencies**: For a given agent or team, the script reads its definition file.
139
+ 2. It recursively finds all dependent resources (tasks, templates, etc.) that the agent/team needs.
140
+ 3. **Bundles Content**: It reads the content of all these files and concatenates them into a single, large text file, with clear separators indicating the original file path of each section.
141
+ 4. **Outputs Bundle**: The final `.txt` file is saved in the `web-bundles` directory, ready to be uploaded to a web UI.
142
+
143
+ ### 4.2. Environment-Specific Usage
144
+
145
+ - **For IDEs**: Users interact with the agents directly via their markdown files in `.bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
146
+ - **For Web UIs**: Users upload a pre-built bundle from `.bmad-core/web-bundles/`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
147
+
148
+ ## 5. BMAD Workflows
149
+
150
+ ### 5.1. The Planning Workflow
151
+
152
+ Before development begins, BMAD follows a structured planning workflow that establishes the foundation for successful project execution:
153
+
154
+ ```mermaid
155
+ graph TD
156
+ A["Start: Project Idea"] --> B{"Optional: Analyst Brainstorming"}
157
+ B -->|Yes| C["Analyst: Market Research & Analysis"]
158
+ B -->|No| D["Create Project Brief"]
159
+ C --> D["Analyst: Create Project Brief"]
160
+ D --> E["PM: Create PRD from Brief"]
161
+ E --> F["Architect: Create Architecture from PRD"]
162
+ F --> G["PO: Run Master Checklist"]
163
+ G --> H{"Documents Aligned?"}
164
+ H -->|Yes| I["Planning Complete"]
165
+ H -->|No| J["PO: Update Epics & Stories"]
166
+ J --> K["Update PRD/Architecture as needed"]
167
+ K --> G
168
+ I --> L["📁 Switch to IDE"]
169
+ L --> M["PO: Shard Documents"]
170
+ M --> N["Ready for SM/Dev Cycle"]
171
+
172
+ style I fill:#34a853,color:#fff
173
+ style G fill:#f9ab00,color:#fff
174
+ style L fill:#1a73e8,color:#fff
175
+ style N fill:#34a853,color:#fff
176
+ ````
177
+
178
+ **Key Planning Phases:**
179
+
180
+ 1. **Optional Analysis**: Analyst conducts market research and competitive analysis
181
+ 2. **Project Brief**: Foundation document created by Analyst or user
182
+ 3. **PRD Creation**: PM transforms brief into comprehensive product requirements
183
+ 4. **Architecture Design**: Architect creates technical foundation based on PRD
184
+ 5. **Validation & Alignment**: PO ensures all documents are consistent and complete
185
+ 6. **Refinement**: Updates to epics, stories, and documents as needed
186
+ 7. **Environment Transition**: Critical switch from web UI to IDE for development workflow
187
+ 8. **Document Preparation**: PO shards large documents for development consumption
188
+
189
+ **Workflow Orchestration**: The `bmad-orchestrator` agent uses these workflow definitions to guide users through the complete process, ensuring proper transitions between planning (web UI) and development (IDE) phases.
190
+
191
+ ### 5.2. The Core Development Cycle
192
+
193
+ Once the initial planning and architecture phases are complete, the project moves into a cyclical development workflow, as detailed in the `bmad-kb.md`. This ensures a steady, sequential, and quality-controlled implementation process.
194
+
195
+ ```mermaid
196
+ graph TD
197
+ A["Start: Planning Artifacts Complete"] --> B["PO: Shard Epics"]
198
+ B --> C["PO: Shard Arch"]
199
+ C --> D["Development Phase"]
200
+ D --> E["Scrum Master: Drafts next story from sharded epic"]
201
+ E --> F{"User Approval"}
202
+ F -->|Approved| G["Dev: Implement Story"]
203
+ F -->|Needs Changes| E
204
+ G --> H["Dev: Complete story Tasks"]
205
+ H --> I{"User Verification"}
206
+ I -->|Verified Complete| J["Mark Story as Done"]
207
+ I -->|Needs Fixes| G
208
+ J --> E
209
+
210
+ style J fill:#34a853,color:#fff
211
+ ```
212
+
213
+ This cycle continues, with the Scrum Master and Developer agents working in tandem, until all stories in the epic are completed.
@@ -0,0 +1,127 @@
1
+ # BMAD Method Guide for Cursor
2
+
3
+ This guide walks you through the complete BMAD workflow using Cursor as your AI-powered IDE.
4
+
5
+ ## Step 1: Install BMAD in Your Project
6
+
7
+ 1. Navigate to your project directory
8
+ 2. Run the BMAD installer:
9
+ ```bash
10
+ npx bmad-method install
11
+ ```
12
+ 3. When prompted:
13
+ - **Installation Type**: Choose "Complete installation (recommended)"
14
+ - **IDE**: Select "Cursor"
15
+
16
+ This creates a `.bmad-core` folder with all agents and a `.cursor/rules` folder with agent rules.
17
+
18
+ ## Step 2: Set Up Team Fullstack in Gemini
19
+
20
+ For ideation and planning, use Google's Gemini with the team-fullstack configuration:
21
+
22
+ 1. Open [Google AI Studio (Gemini)](https://aistudio.google.com/)
23
+ 2. Create a new chat
24
+ 3. Copy the contents of `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
25
+ 4. Paste this content into Gemini to set up the team
26
+
27
+ ### Gemini Planning Phase
28
+
29
+ In Gemini, ask the BMAD team to help you:
30
+
31
+ - **Ideate** your project concept
32
+ - **Brainstorm** features and requirements
33
+ - **Create a PRD** (Product Requirements Document)
34
+ - **Design the architecture**
35
+
36
+ Ask questions like:
37
+
38
+ - "Help me brainstorm a [type of application] that does [core functionality]"
39
+ - "Create a comprehensive PRD for this concept"
40
+ - "Design the technical architecture for this system"
41
+
42
+ Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
43
+
44
+ - `docs/prd.md`
45
+ - `docs/architecture.md`
46
+
47
+ ## Step 3: Back to Cursor - Document Sharding
48
+
49
+ Once you have your PRD and architecture documents in the `docs/` folder:
50
+
51
+ 1. **Start a new chat in Cursor**
52
+ 2. **Load the bmad-master agent**: Type `@bmad-master`
53
+ 3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
54
+ 4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
55
+
56
+ This creates organized folders:
57
+
58
+ - `docs/prd/` - Contains broken down PRD sections
59
+ - `docs/architecture/` - Contains broken down architecture sections
60
+
61
+ ## Step 4: Story Development Cycle
62
+
63
+ Now begin the iterative development cycle:
64
+
65
+ ### Create Stories (Scrum Master)
66
+
67
+ 1. **Start a new chat**
68
+ 2. **Load SM agent**: Type `@sm`
69
+ 3. **Create story**: Type `*create` (this runs the create-next-story task)
70
+ 4. **Review the generated story**
71
+ 5. **If approved**: Set story status to "Approved" in the story file
72
+
73
+ ### Implement Stories (Developer)
74
+
75
+ 1. **Start a new chat**
76
+ 2. **Load Dev agent**: Type `@dev`
77
+ 3. **The agent will ask which story to implement**
78
+ 4. **Follow the development tasks** the agent provides
79
+ 5. **When story is complete**: Mark status as "Done"
80
+
81
+ ### Repeat the Cycle
82
+
83
+ 1. **Start a new chat with SM agent** (`@sm`)
84
+ 2. **Create next story**: Type `*create`
85
+ 3. **Review and approve**
86
+ 4. **Start new chat with Dev agent** (`@dev`)
87
+ 5. **Implement the story**
88
+ 6. **Repeat until project complete**
89
+
90
+ ## Available Agent Rules in Cursor
91
+
92
+ All BMAD agents are available as Cursor rules (use `@` prefix):
93
+
94
+ - `@bmad-master` - Universal task executor
95
+ - `@sm` - Scrum Master for story creation
96
+ - `@dev` - Full-stack developer for implementation
97
+ - `@architect` - Solution architect for design
98
+ - `@pm` - Product manager for planning
99
+ - `@analyst` - Business analyst for requirements
100
+ - `@qa` - QA specialist for testing
101
+ - `@po` - Product owner for prioritization
102
+ - `@ux-expert` - UX specialist for design
103
+
104
+ ## Cursor-Specific Features
105
+
106
+ - **Agent rules are stored in**: `.cursor/rules/` as `.mdc` files
107
+ - **Auto-completion**: Cursor will suggest `@agent-name` as you type
108
+ - **Rule activation**: Rules activate automatically when you mention `@agent-name`
109
+ - **Context awareness**: Agents have access to your current file context
110
+
111
+ ## Key Workflow Principles
112
+
113
+ 1. **Always start new chats** when switching agents to avoid context confusion
114
+ 2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
115
+ 3. **Use bmad-master for document management** (sharding, templates, etc.)
116
+ 4. **Follow the SM → Dev cycle** for consistent story development
117
+ 5. **Review and approve stories** before implementation begins
118
+
119
+ ## Tips for Success
120
+
121
+ - **Keep chats focused**: Each chat should have one agent and one primary task
122
+ - **Use \*help command**: Every agent supports `*help` to see available commands
123
+ - **Review generated content**: Always review and approve stories before marking them ready
124
+ - **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
125
+ - **Leverage Cursor's context**: Agents can see your current file selection for better assistance
126
+
127
+ This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
@@ -0,0 +1,141 @@
1
+ # How to Contribute with Pull Requests
2
+
3
+ **New to GitHub and pull requests?** This guide will walk you through the basics step by step.
4
+
5
+ ## What is a Pull Request?
6
+
7
+ A pull request (PR) is how you propose changes to a project on GitHub. Think of it as saying "Here are some changes I'd like to make - please review and consider adding them to the main project."
8
+
9
+ ## Before You Start
10
+
11
+ ⚠️ **Important**: Please keep your contributions small and focused! We prefer many small, clear changes rather than one massive change. If you're planning something big, please [open an issue](https://github.com/bmadcode/bmad-method/issues) or start a [discussion](https://github.com/bmadcode/bmad-method/discussions) first.
12
+
13
+ ## Step-by-Step Guide
14
+
15
+ ### 1. Fork the Repository
16
+
17
+ 1. Go to the [BMAD-METHOD repository](https://github.com/bmadcode/bmad-method)
18
+ 2. Click the "Fork" button in the top-right corner
19
+ 3. This creates your own copy of the project
20
+
21
+ ### 2. Clone Your Fork
22
+
23
+ ````bash
24
+ # Replace YOUR-USERNAME with your actual GitHub username
25
+ git clone https://github.com/YOUR-USERNAME/bmad-method.git
26
+ cd bmad-method
27
+ ```text
28
+
29
+ ### 3. Create a New Branch
30
+
31
+ **Never work directly on the `main` branch!** Always create a new branch for your changes:
32
+
33
+ ```bash
34
+ # Create and switch to a new branch
35
+ git checkout -b fix/typo-in-readme
36
+ # or
37
+ git checkout -b feature/add-new-agent
38
+ ````
39
+
40
+ **Branch naming tips:**
41
+
42
+ - `fix/description` - for bug fixes
43
+ - `feature/description` - for new features
44
+ - `docs/description` - for documentation changes
45
+
46
+ ### 4. Make Your Changes
47
+
48
+ - Edit the files you want to change
49
+ - Keep changes small and focused on one thing
50
+ - Test your changes if possible
51
+
52
+ ### 5. Commit Your Changes
53
+
54
+ ````bash
55
+ # Add your changes
56
+ git add .
57
+
58
+ # Commit with a clear message
59
+ git commit -m "Fix typo in README.md"
60
+ ```text
61
+
62
+ **Good commit messages:**
63
+
64
+ - "Fix typo in installation instructions"
65
+ - "Add example for new agent usage"
66
+ - "Update broken link in docs"
67
+
68
+ **Bad commit messages:**
69
+
70
+ - "stuff"
71
+ - "changes"
72
+ - "update"
73
+
74
+ ### 6. Push to Your Fork
75
+
76
+ ```bash
77
+ # Push your branch to your fork
78
+ git push origin fix/typo-in-readme
79
+ ````
80
+
81
+ ### 7. Create the Pull Request
82
+
83
+ 1. Go to your fork on GitHub
84
+ 2. You'll see a green "Compare & pull request" button - click it
85
+ 3. Fill out the PR template:
86
+ - **Title**: Clear, descriptive title
87
+ - **Description**: Explain what you changed and why
88
+
89
+ ### 8. Wait for Review
90
+
91
+ - A maintainer will review your PR
92
+ - They might ask for changes
93
+ - Be patient and responsive to feedback
94
+
95
+ ## What Makes a Good Pull Request?
96
+
97
+ ✅ **Good PRs:**
98
+
99
+ - Change one thing at a time
100
+ - Have clear, descriptive titles
101
+ - Explain what and why in the description
102
+ - Include only the files that need to change
103
+
104
+ ❌ **Avoid:**
105
+
106
+ - Changing formatting of entire files
107
+ - Multiple unrelated changes in one PR
108
+ - Copying your entire project/repo into the PR
109
+ - Changes without explanation
110
+
111
+ ## Common Mistakes to Avoid
112
+
113
+ 1. **Don't reformat entire files** - only change what's necessary
114
+ 2. **Don't include unrelated changes** - stick to one fix/feature per PR
115
+ 3. **Don't paste code in issues** - create a proper PR instead
116
+ 4. **Don't submit your whole project** - contribute specific improvements
117
+
118
+ ## Need Help?
119
+
120
+ - 💬 Join our [Discord Community](https://discord.gg/g6ypHytrCB) for real-time help
121
+ - 💬 Ask questions in [Discussions](https://github.com/bmadcode/bmad-method/discussions)
122
+ - 🐛 Report bugs in [Issues](https://github.com/bmadcode/bmad-method/issues)
123
+ - 📖 Read the full [Contributing Guidelines](../CONTRIBUTING.md)
124
+
125
+ ## Example: Good vs Bad PRs
126
+
127
+ ### 😀 Good PR Example
128
+
129
+ **Title**: "Fix broken link to installation guide"
130
+ **Changes**: One file, one line changed
131
+ **Description**: "The link in README.md was pointing to the wrong file. Updated to point to correct installation guide."
132
+
133
+ ### 😞 Bad PR Example
134
+
135
+ **Title**: "Updates"
136
+ **Changes**: 50 files, entire codebase reformatted
137
+ **Description**: "Made some improvements"
138
+
139
+ ---
140
+
141
+ **Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner.