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
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMAD Method Universal Workflow Guide
|
|
2
2
|
|
|
3
|
-
This guide outlines the core
|
|
3
|
+
This guide outlines the core BMAD workflow that applies regardless of which AI-powered IDE you're using.
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
7
|
-
The
|
|
7
|
+
The BMAD Method follows a structured approach to AI-assisted software development:
|
|
8
8
|
|
|
9
|
-
1. **Install
|
|
9
|
+
1. **Install BMAD** in your project
|
|
10
10
|
2. **Plan with Gemini** using team-fullstack
|
|
11
11
|
3. **Organize with bmad-master** (document sharding)
|
|
12
12
|
4. **Develop iteratively** with SM → Dev cycles
|
|
@@ -15,14 +15,14 @@ The BMad Method follows a structured approach to AI-assisted software developmen
|
|
|
15
15
|
|
|
16
16
|
### Phase 1: Project Setup
|
|
17
17
|
|
|
18
|
-
1. **Install
|
|
18
|
+
1. **Install BMAD in your project**:
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
21
|
npx bmad-method install
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
- Choose "Complete installation"
|
|
25
|
-
- Select your IDE (Cursor, Claude Code, Windsurf,
|
|
25
|
+
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
|
26
26
|
|
|
27
27
|
2. **Verify installation**:
|
|
28
28
|
- `.bmad-core/` folder created with all agents
|
|
@@ -33,13 +33,11 @@ The BMad Method follows a structured approach to AI-assisted software developmen
|
|
|
33
33
|
|
|
34
34
|
Use Google's Gemini for collaborative planning with the full team:
|
|
35
35
|
|
|
36
|
-
1. **Open [Google
|
|
37
|
-
2. **
|
|
38
|
-
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
- Paste this content into the Gem setup to configure the team
|
|
42
|
-
4. **Collaborate with the team**:
|
|
36
|
+
1. **Open [Google AI Studio](https://aistudio.google.com/)**
|
|
37
|
+
2. **Load team-fullstack**:
|
|
38
|
+
- Copy contents of: `/Users/brianmadison/dev/BMAD-METHOD/.bmad-core/web-bundles/teams/team-fullstack.txt`
|
|
39
|
+
- Paste into new Gemini chat
|
|
40
|
+
3. **Collaborate with the team**:
|
|
43
41
|
- Business Analyst: Requirements gathering
|
|
44
42
|
- Product Manager: Feature prioritization
|
|
45
43
|
- Solution Architect: Technical design
|
|
@@ -55,9 +53,9 @@ Help me brainstorm features and create a comprehensive PRD."
|
|
|
55
53
|
that can handle [specific requirements]."
|
|
56
54
|
```
|
|
57
55
|
|
|
58
|
-
|
|
59
|
-
-
|
|
60
|
-
-
|
|
56
|
+
4. **Export planning documents**:
|
|
57
|
+
- Save PRD as `docs/prd.md`
|
|
58
|
+
- Save architecture as `docs/architecture.md`
|
|
61
59
|
|
|
62
60
|
### Phase 3: Document Organization (IDE)
|
|
63
61
|
|
|
@@ -112,13 +110,11 @@ Follow the SM → Dev cycle for systematic story development:
|
|
|
112
110
|
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
113
111
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
114
112
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
115
|
-
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
|
116
113
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
117
|
-
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
118
114
|
|
|
119
115
|
### Chat Management:
|
|
120
116
|
|
|
121
|
-
- **Claude Code, Cursor, Windsurf
|
|
117
|
+
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
122
118
|
- **Roo Code**: Switch modes within the same conversation
|
|
123
119
|
|
|
124
120
|
## Available Agents
|
|
@@ -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,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,140 @@
|
|
|
1
|
+
# BMAD Method Guide for Roo Code
|
|
2
|
+
|
|
3
|
+
This guide walks you through the complete BMAD workflow using Roo 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 "Roo Code"
|
|
15
|
+
|
|
16
|
+
This creates a `.bmad-core` folder with all agents and a `.roo/.roomodes` file with custom modes.
|
|
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 Roo Code - Document Sharding
|
|
48
|
+
|
|
49
|
+
Once you have your PRD and architecture documents in the `docs/` folder:
|
|
50
|
+
|
|
51
|
+
1. **Open your project in Roo Code**
|
|
52
|
+
2. **Select the bmad-master mode** from the mode selector (usually in status bar)
|
|
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 or conversation**
|
|
68
|
+
2. **Switch to SM mode**: Select `bmad-sm` from the mode selector
|
|
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 conversation**
|
|
76
|
+
2. **Switch to Dev mode**: Select `bmad-dev` from the mode selector
|
|
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. **Switch to SM mode** (`bmad-sm`)
|
|
84
|
+
2. **Create next story**: Type `*create`
|
|
85
|
+
3. **Review and approve**
|
|
86
|
+
4. **Switch to Dev mode** (`bmad-dev`)
|
|
87
|
+
5. **Implement the story**
|
|
88
|
+
6. **Repeat until project complete**
|
|
89
|
+
|
|
90
|
+
## Available Custom Modes in Roo Code
|
|
91
|
+
|
|
92
|
+
All BMAD agents are available as custom modes:
|
|
93
|
+
|
|
94
|
+
- `bmad-bmad-master` - 🧙 Universal task executor
|
|
95
|
+
- `bmad-sm` - 🏃 Scrum Master for story creation
|
|
96
|
+
- `bmad-dev` - 💻 Full-stack developer for implementation
|
|
97
|
+
- `bmad-architect` - 🏗️ Solution architect for design
|
|
98
|
+
- `bmad-pm` - 📋 Product manager for planning
|
|
99
|
+
- `bmad-analyst` - 📊 Business analyst for requirements
|
|
100
|
+
- `bmad-qa` - 🧪 QA specialist for testing
|
|
101
|
+
- `bmad-po` - 🎯 Product owner for prioritization
|
|
102
|
+
- `bmad-ux-expert` - 🎨 UX specialist for design
|
|
103
|
+
|
|
104
|
+
## Roo Code-Specific Features
|
|
105
|
+
|
|
106
|
+
- **Custom modes are stored in**: `.roo/.roomodes` file
|
|
107
|
+
- **Mode switching**: Use the mode selector in Roo Code's interface
|
|
108
|
+
- **File permissions**: Each agent has specific file access permissions
|
|
109
|
+
- **Documentation agents** (SM, PM, PO, Analyst): Limited to `.md` and `.txt` files
|
|
110
|
+
- **Technical agents** (Dev, Architect, Master): Full file access
|
|
111
|
+
- **QA agents**: Access to test files and documentation
|
|
112
|
+
- **UX agents**: Access to design-related files
|
|
113
|
+
- **Context preservation**: Modes maintain context within conversations
|
|
114
|
+
|
|
115
|
+
## Key Workflow Principles
|
|
116
|
+
|
|
117
|
+
1. **Switch modes instead of starting new chats** - Roo Code handles context better with mode switching
|
|
118
|
+
2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
|
|
119
|
+
3. **Use bmad-master mode for document management** (sharding, templates, etc.)
|
|
120
|
+
4. **Follow the SM → Dev mode cycle** for consistent story development
|
|
121
|
+
5. **Review and approve stories** before implementation begins
|
|
122
|
+
|
|
123
|
+
## Tips for Success
|
|
124
|
+
|
|
125
|
+
- **Use mode selector effectively**: Switch modes as needed for different tasks
|
|
126
|
+
- **Respect file permissions**: Agents can only edit files they have permission for
|
|
127
|
+
- **Use \*help command**: Every mode supports `*help` to see available commands
|
|
128
|
+
- **Review generated content**: Always review and approve stories before marking them ready
|
|
129
|
+
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
|
130
|
+
- **Leverage Roo's context**: Modes can maintain context across the conversation
|
|
131
|
+
|
|
132
|
+
## File Permission Summary
|
|
133
|
+
|
|
134
|
+
- **bmad-analyst, bmad-pm, bmad-po, bmad-sm**: `.md`, `.txt` files only
|
|
135
|
+
- **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json` files
|
|
136
|
+
- **bmad-qa**: Test files (`.test.js`, `.spec.ts`, etc.) and `.md` files
|
|
137
|
+
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx` files
|
|
138
|
+
- **bmad-dev, bmad-bmad-master, bmad-orchestrator**: Full file access
|
|
139
|
+
|
|
140
|
+
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# PRD
|
|
2
|
+
|
|
3
|
+
## Epic 1: Core To-Do Functionality
|
|
4
|
+
|
|
5
|
+
**Goal:** To deliver a functional, single-user to-do application with user authentication and full CRUD (Create, Read, Update, Delete) capabilities for tasks.
|
|
6
|
+
|
|
7
|
+
**Stories:**
|
|
8
|
+
|
|
9
|
+
**Story 1.1: User Authentication**
|
|
10
|
+
|
|
11
|
+
- **As a** user,
|
|
12
|
+
- **I want** to be able to sign up, log in, and log out,
|
|
13
|
+
- **so that** I can securely manage my personal to-do list.
|
|
14
|
+
- **Acceptance Criteria:**
|
|
15
|
+
1. The application uses the Supabase Auth UI for login and sign-up forms.
|
|
16
|
+
2. A user can create an account and will be automatically logged in.
|
|
17
|
+
3. A logged-in user can log out, which redirects them to the login page.
|
|
18
|
+
4. The main to-do list page is protected and only visible to authenticated users.
|
|
19
|
+
|
|
20
|
+
**Story 1.2: Create and View To-Dos**
|
|
21
|
+
|
|
22
|
+
- **As an** authenticated user,
|
|
23
|
+
- **I want** to enter a task into an input field and see it appear on my to-do list,
|
|
24
|
+
- **so that** I can keep track of my tasks.
|
|
25
|
+
- **Acceptance Criteria:**
|
|
26
|
+
1. There is a text input field and a "Create" button on the main page.
|
|
27
|
+
2. Submitting a new task adds it to the database and displays it in the list of to-dos without a page refresh.
|
|
28
|
+
3. The to-do list is fetched from the Supabase database when the page loads.
|
|
29
|
+
4. The input field is cleared after a to-do is successfully created.
|
|
30
|
+
|
|
31
|
+
**Story 1.3: Update and Delete To-Dos**
|
|
32
|
+
|
|
33
|
+
- **As an** authenticated user,
|
|
34
|
+
- **I want** to be able to mark a to-do as complete and delete it,
|
|
35
|
+
- **so that** I can manage my task list effectively.
|
|
36
|
+
- **Acceptance Criteria:**
|
|
37
|
+
1. Each to-do item has a checkbox or button to toggle its "completed" status.
|
|
38
|
+
2. Changing the status updates the item in the database and visually (e.g., with a strikethrough).
|
|
39
|
+
3. Each to-do item has a "Delete" button.
|
|
40
|
+
4. Clicking "Delete" removes the to-do from the UI and the database.
|
|
41
|
+
|
|
42
|
+
With this epic, the planning phase is complete. All the requirements are clearly defined and structured for development.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Automated Releases (Recommended)
|
|
4
4
|
|
|
5
|
-
The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push
|
|
5
|
+
The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push - everything else happens automatically!
|
|
6
6
|
|
|
7
7
|
### Commit Message Format
|
|
8
8
|
|
|
9
9
|
Use these prefixes to control what type of release happens:
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
````bash
|
|
12
12
|
fix: resolve CLI argument parsing bug # → patch release (4.1.0 → 4.1.1)
|
|
13
13
|
feat: add new agent orchestration mode # → minor release (4.1.0 → 4.2.0)
|
|
14
14
|
feat!: redesign CLI interface # → major release (4.1.0 → 5.0.0)
|
|
15
|
-
```
|
|
15
|
+
```text
|
|
16
16
|
|
|
17
17
|
### What Happens Automatically
|
|
18
18
|
|
|
@@ -35,30 +35,30 @@ git push
|
|
|
35
35
|
|
|
36
36
|
# That's it! Release happens automatically 🎉
|
|
37
37
|
# Users can now run: npx bmad-method (and get the new version)
|
|
38
|
-
|
|
38
|
+
````
|
|
39
39
|
|
|
40
40
|
### Commits That DON'T Trigger Releases
|
|
41
41
|
|
|
42
42
|
These commit types won't create releases (use them for maintenance):
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
````bash
|
|
45
45
|
chore: update dependencies # No release
|
|
46
46
|
docs: fix typo in readme # No release
|
|
47
47
|
style: format code # No release
|
|
48
48
|
test: add unit tests # No release
|
|
49
|
-
```
|
|
49
|
+
```text
|
|
50
50
|
|
|
51
51
|
### Test Your Setup
|
|
52
52
|
|
|
53
53
|
```bash
|
|
54
54
|
npm run release:test # Safe to run locally - tests the config
|
|
55
|
-
|
|
55
|
+
````
|
|
56
56
|
|
|
57
57
|
---
|
|
58
58
|
|
|
59
59
|
## Manual Release Methods (Exceptions Only)
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
**⚠️ Only use these methods if you need to bypass the automatic system**
|
|
62
62
|
|
|
63
63
|
### Quick Manual Version Bump
|
|
64
64
|
|
|
@@ -75,3 +75,11 @@ git push && git push --tags
|
|
|
75
75
|
### Manual GitHub Actions Trigger
|
|
76
76
|
|
|
77
77
|
You can also trigger releases manually through GitHub Actions workflow dispatch if needed.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Summary
|
|
82
|
+
|
|
83
|
+
**For 99% of releases**: Just use `fix:` or `feat:` commit messages and push. Everything else is automatic!
|
|
84
|
+
|
|
85
|
+
**Manual methods**: Only needed for special cases or if you want to bypass the automated system.
|
package/docs/versions.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Previous Versions
|
|
4
4
|
|
|
5
|
-
- [Version 3](https://github.com/bmadcode/
|
|
6
|
-
- [Version 2](https://github.com/bmadcode/
|
|
7
|
-
- [Version 1](https://github.com/bmadcode/
|
|
5
|
+
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3)
|
|
6
|
+
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2)
|
|
7
|
+
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1)
|
|
8
8
|
|
|
9
9
|
## Current Version: V4 - Alpha
|
|
10
10
|
|
|
@@ -16,6 +16,7 @@ Guiding Principles of V4:
|
|
|
16
16
|
- Helpers for installers and web builders that will work with any OS and IDE easily
|
|
17
17
|
- Align all agents to be the same for IDE and Web, without losing the power of the web versions, or the leanness of the files in the IDE to reduce context
|
|
18
18
|
- Further improvements to the two most important agents - the SM and DEV
|
|
19
|
+
- Expansion Packs - Coming soon...
|
|
19
20
|
|
|
20
21
|
## V3
|
|
21
22
|
|
|
@@ -25,7 +26,7 @@ V3 didn't fix the disconnect, but it did make it easier to maintain them all in
|
|
|
25
26
|
|
|
26
27
|
V3's biggest impact was a full explosion of customizability. Tasks, Personas, Agent Configurations, Doc Templates, data payloads.
|
|
27
28
|
|
|
28
|
-
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The
|
|
29
|
+
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMAD AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
|
|
29
30
|
|
|
30
31
|
Now, instead of configuring 4+ web agents, all needing many files uploaded to create them, a single Agent called BMad, with a whole team, and the ability to switch and maintain personas evolved. Now you could in the same chat thread, talk to the whole team, or anyone on the team. No more exporting and reimporting docs to different chats - all of the sudden, you could finish the PRD, and ask Josh to pass it off to the Architect, and that was it, the architect just had it and we moved on! And all of that with just 7 total files to upload, delivering all power.
|
|
31
32
|
|