bmad-method 4.22.1 → 4.24.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [4.24.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.23.0...v4.24.0) (2025-07-02)
+
+
+### Bug Fixes
+
+* corrected cursor agent update instructions ([84e394a](https://github.com/bmadcode/BMAD-METHOD/commit/84e394ac11136d9cf8164cefc9ca8e298e8ef0ec))
+
+
+### Features
+
+* workflow plans introduced, preliminary feature under review ([731589a](https://github.com/bmadcode/BMAD-METHOD/commit/731589aa287c31ea120e232b4dcc07e9790500ff))
+
+# [4.23.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.1...v4.23.0) (2025-07-01)
+
+
+### Features
+
+* VS Code Copilot integration ([#284](https://github.com/bmadcode/BMAD-METHOD/issues/284)) ([1a4ca4f](https://github.com/bmadcode/BMAD-METHOD/commit/1a4ca4ffa630c2d4156bdd7a040d4c2274801757))
+
 ## [4.22.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.0...v4.22.1) (2025-06-30)
 
 

package/README.md

@@ -156,7 +156,7 @@ The BMad Method works with any IDE, but has built-in integration for:
 - `gemini-cli` - Gemini with @agent commands
 - `windsurf` - Windsurf with manual rule @agent commands
 - `roo` - Roo Code with custom modes (see `.roomodes`)
-- `windsurf` - Windsurf with @agent commands
+- `vs-code-copilot` - VS Code with GitHub Copilot agent mode integration
 
 ## Available Agents
 
@@ -290,10 +290,11 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour
 - 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
 - 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
 - ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
+- 💻 [VS Code Copilot Guide](docs/agentic-tools/vs-code-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
 
 ## 🌟 Beyond Software Development - Expansion Packs
 
-While BMAD excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMAD into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
+While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMAD into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
 
 ### Available Expansion Packs
 

package/bmad-core/agents/bmad-master.md

@@ -26,6 +26,9 @@ persona:
     - Process (*) commands immediately
 startup:
   - Greet the user with your name and role, and inform of the *help command.
+  - Check for active workflow plan using utils#plan-management
+  - "If plan exists: Show brief status - Active plan detected: {workflow} - {progress}%"
+  - "If plan exists: Suggest next step based on plan"
   - CRITICAL: Do NOT scan filesystem or load any resources during startup
   - CRITICAL: Do NOT run discovery tasks automatically
   - Wait for user request before any tool use
@@ -37,16 +40,24 @@ commands:  # All commands require * prefix when used (e.g., *help)
   - status: Current context
   - task {template|util|checklist|workflow}: Execute
   - list {task|template|util|checklist|workflow}: List resources by type
+  - plan: Create workflow plan (for complex projects)
+  - plan-status: Show current workflow plan progress
+  - plan-update: Update workflow plan status
   - exit: Exit (confirm)
   - yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
   - doc-out: Output full document
 fuzzy-matching:
   - 85% confidence threshold
   - Show numbered list if unsure
+workflow-guidance:
+  - When user asks about workflows, offer: "Would you like me to create a workflow plan first? (*plan)"
+  - For complex projects, suggest planning before execution
+  - Plan command maps to create-workflow-plan task
 execution:
   - NEVER use tools during startup - only announce and wait
   - Runtime discovery ONLY when user requests specific resources
   - Workflow: User request → Runtime discovery → Load resource → Execute instructions → Guide inputs → Provide feedback
+  - For workflow requests: Suggest *plan command first for complex projects
   - Suggest related resources after completion
 dependencies:
   tasks:
@@ -58,12 +69,14 @@ dependencies:
     - correct-course
     - create-deep-research-prompt
     - create-doc
+    - create-workflow-plan
     - document-project
     - create-next-story
     - execute-checklist
     - generate-ai-frontend-prompt
     - index-docs
     - shard-doc
+    - update-workflow-plan
   templates:
     - agent-tmpl
     - architecture-tmpl
@@ -81,7 +94,7 @@ dependencies:
     - bmad-kb
     - technical-preferences
   utils:
-    - agent-switcher.ide
+    - plan-management
     - template-format
     - workflow-management
   workflows:

package/bmad-core/agents/bmad-orchestrator.md

@@ -31,6 +31,9 @@ startup:
   - Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
   - IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
   - Mention *help shows all available commands and options
+  - Check for active workflow plan using utils#plan-management
+  - "If plan exists: Show 📋 Active plan: {workflow} ({progress}% complete). Use *plan-status for details."
+  - "If plan exists: Suggest next action based on plan progress"
   - Assess user goal against available agents and workflows in this bundle
   - If clear match to an agent's expertise, suggest transformation with *agent command
   - If project-oriented, suggest *workflow-guidance to explore options
@@ -45,6 +48,9 @@ commands:  # All commands require * prefix when used (e.g., *help, *agent pm)
   task: Run a specific task (list if name not specified)
   workflow: Start a specific workflow (list if name not specified)
   workflow-guidance: Get personalized help selecting the right workflow
+  plan: Create detailed workflow plan before starting
+  plan-status: Show current workflow plan progress
+  plan-update: Update workflow plan status
   checklist: Execute a checklist (list if name not specified)
   yolo: Toggle skip confirmations mode
   party-mode: Group chat with all agents
@@ -68,6 +74,9 @@ help-display-template: |
   Workflow Commands:
   *workflow [name] .... Start specific workflow (list if no name)
   *workflow-guidance .. Get personalized help selecting the right workflow
+  *plan ............... Create detailed workflow plan before starting
+  *plan-status ........ Show current workflow plan progress
+  *plan-update ........ Update workflow plan status
   
   Other Commands:
   *yolo ............... Toggle skip confirmations mode
@@ -109,6 +118,8 @@ workflow-guidance:
   - Understand each workflow's purpose, options, and decision points
   - Ask clarifying questions based on the workflow's structure
   - Guide users through workflow selection when multiple options exist
+  - For complex projects, offer to create a workflow plan using create-workflow-plan task
+  - When appropriate, suggest: "Would you like me to create a detailed workflow plan before starting?"
   - For workflows with divergent paths, help users choose the right path
   - Adapt questions to the specific domain (e.g., game dev vs infrastructure vs web dev)
   - Only recommend workflows that actually exist in the current bundle
@@ -117,10 +128,13 @@ dependencies:
   tasks:
     - advanced-elicitation
     - create-doc
+    - create-workflow-plan
     - kb-mode-interaction
+    - update-workflow-plan
   data:
     - bmad-kb
   utils:
+    - plan-management
     - workflow-management
     - template-format
 ```

package/bmad-core/core-config.yml

@@ -18,3 +18,8 @@ devLoadAlwaysFiles:
   - docs/architecture/source-tree.md
 devDebugLog: .ai/debug-log.md
 devStoryLocation: docs/stories
+workflow:
+  planFile: docs/workflow-plan.md
+  trackProgress: true
+  enforceSequence: false
+  updateOnCompletion: true

package/bmad-core/data/bmad-kb.md

@@ -78,7 +78,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
 5. Type `/help` to see available commands
 
 #### Option 2: IDE Integration
-**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code users
+**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
 
 ```bash
 # Interactive installation (recommended)
@@ -93,6 +93,7 @@ npx bmad-method install
   - **Windsurf**: Built-in AI capabilities
   - **Cline**: VS Code extension with AI features
   - **Roo Code**: Web-based IDE with agent support
+  - **VS Code Copilot**: AI-powered coding assistant
 
 **Note for VS Code Users**: BMAD-METHOD assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMAD agents. The installer includes built-in support for Cline and Roo.
 
@@ -278,6 +279,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
 - **Cursor**: `@agent-name` (e.g., `@bmad-master`)
 - **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
 - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
+- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
 
 **Chat Management Guidelines**:
 - **Claude Code, Cursor, Windsurf**: Start new chats when switching agents

package/bmad-core/tasks/create-brownfield-story.md

@@ -0,0 +1,355 @@
+# Create Brownfield Story Task
+
+## Purpose
+
+Create detailed, implementation-ready stories for brownfield projects where traditional sharded PRD/architecture documents may not exist. This task bridges the gap between various documentation formats (document-project output, brownfield PRDs, epics, or user documentation) and executable stories for the Dev agent.
+
+## When to Use This Task
+
+**Use this task when:**
+
+- Working on brownfield projects with non-standard documentation
+- Stories need to be created from document-project output
+- Working from brownfield epics without full PRD/architecture
+- Existing project documentation doesn't follow BMAD v4+ structure
+- Need to gather additional context from user during story creation
+
+**Use create-next-story when:**
+
+- Working with properly sharded PRD and v4 architecture documents
+- Following standard greenfield or well-documented brownfield workflow
+- All technical context is available in structured format
+
+## Task Execution Instructions
+
+### 0. Check Workflow Plan and Documentation Context
+
+[[LLM: Check for workflow plan first, then available documentation]]
+
+#### 0.1 Check Workflow Plan
+
+- Load core-config.yml and check if `workflow.trackProgress: true`
+- If yes, check for active plan at `workflow.planFile`
+- If plan exists:
+  - Verify story creation aligns with current plan step
+  - If out of sequence, warn user (enforce based on config)
+  - Note which step this story creation corresponds to
+
+#### 0.2 Determine Documentation Context
+
+Check for available documentation in this order:
+
+1. **Sharded PRD/Architecture** (docs/prd/, docs/architecture/)
+   - If found, recommend using create-next-story task instead
+
+2. **Brownfield Architecture Document** (docs/brownfield-architecture.md or similar)
+   - Created by document-project task
+   - Contains actual system state, technical debt, workarounds
+
+3. **Brownfield PRD** (docs/prd.md)
+   - May contain embedded technical details
+
+4. **Epic Files** (docs/epics/ or similar)
+   - Created by brownfield-create-epic task
+
+5. **User-Provided Documentation**
+   - Ask user to specify location and format
+
+### 1. Story Identification and Context Gathering
+
+#### 1.1 Identify Story Source
+
+Based on available documentation:
+
+- **From Brownfield PRD**: Extract stories from epic sections
+- **From Epic Files**: Read epic definition and story list
+- **From User Direction**: Ask user which specific enhancement to implement
+- **No Clear Source**: Work with user to define the story scope
+
+#### 1.2 Gather Essential Context
+
+[[LLM: For brownfield stories, you MUST gather enough context for safe implementation. Be prepared to ask the user for missing information.]]
+
+**Required Information Checklist:**
+
+- [ ] What existing functionality might be affected?
+- [ ] What are the integration points with current code?
+- [ ] What patterns should be followed (with examples)?
+- [ ] What technical constraints exist?
+- [ ] Are there any "gotchas" or workarounds to know about?
+
+If any required information is missing, ask the user:
+
+```
+I need additional context for this brownfield story:
+
+Missing Information:
+- [List specific missing items]
+
+Please provide:
+1. [Specific question about integration]
+2. [Specific question about patterns]
+3. [Specific question about constraints]
+
+Or point me to documentation that contains this information.
+```
+
+### 2. Extract Technical Context from Available Sources
+
+#### 2.1 From Document-Project Output
+
+If using brownfield-architecture.md from document-project:
+
+- **Technical Debt Section**: Note any workarounds affecting this story
+- **Key Files Section**: Identify files that will need modification
+- **Integration Points**: Find existing integration patterns
+- **Known Issues**: Check if story touches problematic areas
+- **Actual Tech Stack**: Verify versions and constraints
+
+#### 2.2 From Brownfield PRD
+
+If using brownfield PRD:
+
+- **Technical Constraints Section**: Extract all relevant constraints
+- **Integration Requirements**: Note compatibility requirements
+- **Code Organization**: Follow specified patterns
+- **Risk Assessment**: Understand potential impacts
+
+#### 2.3 From User Documentation
+
+[[LLM: When working with non-BMAD documentation, actively extract and organize the information into categories the Dev agent will need]]
+
+Ask the user to help identify:
+
+- Relevant technical specifications
+- Existing code examples to follow
+- Integration requirements
+- Testing approaches used in the project
+
+### 3. Story Creation with Progressive Detail Gathering
+
+#### 3.1 Create Initial Story Structure
+
+Start with the story template, filling in what's known:
+
+```markdown
+# Story {{Enhancement Title}}
+
+## Status: Draft
+
+## Story
+As a {{user_type}},
+I want {{enhancement_capability}},
+so that {{value_delivered}}.
+
+## Context Source
+[[LLM: Document where story requirements came from]]
+- Source Document: {{document name/type}}
+- Enhancement Type: {{single feature/bug fix/integration/etc}}
+- Existing System Impact: {{brief assessment}}
+```
+
+#### 3.2 Develop Acceptance Criteria
+
+[[LLM: For brownfield, ALWAYS include criteria about maintaining existing functionality]]
+
+Standard structure:
+
+1. New functionality works as specified
+2. Existing {{affected feature}} continues to work unchanged  
+3. Integration with {{existing system}} maintains current behavior
+4. No regression in {{related area}}
+5. Performance remains within acceptable bounds
+
+#### 3.3 Gather Technical Guidance
+
+[[LLM: This is where you'll need to be interactive with the user if information is missing]]
+
+Create Dev Technical Guidance section with available information:
+
+```markdown
+## Dev Technical Guidance
+
+### Existing System Context
+[Extract from available documentation]
+
+### Integration Approach
+[Based on patterns found or ask user]
+
+### Technical Constraints
+[From documentation or user input]
+
+### Missing Information
+[[LLM: List anything you couldn't find that dev will need]]
+- [ ] {{missing item 1}}
+- [ ] {{missing item 2}}
+```
+
+If critical information is missing, pause and ask:
+
+```
+To complete the technical guidance for this story, I need:
+
+1. **{{Missing Category}}**: 
+   - Specifically: {{what you need to know}}
+   - Why needed: {{how it impacts implementation}}
+   
+Can you provide this information or point me to relevant code/docs?
+```
+
+### 4. Task Generation with Safety Checks
+
+#### 4.1 Generate Implementation Tasks
+
+Based on gathered context, create tasks that:
+
+- Include exploration tasks if system understanding is incomplete
+- Add verification tasks for existing functionality
+- Include rollback considerations
+- Reference specific files/patterns when known
+
+Example task structure for brownfield:
+
+```markdown
+## Tasks / Subtasks
+
+- [ ] Task 1: Analyze existing {{component/feature}} implementation
+  - [ ] Review {{specific files}} for current patterns
+  - [ ] Document integration points
+  - [ ] Identify potential impacts
+
+- [ ] Task 2: Implement {{new functionality}}
+  - [ ] Follow pattern from {{example file}}
+  - [ ] Integrate with {{existing component}}
+  - [ ] Maintain compatibility with {{constraint}}
+
+- [ ] Task 3: Verify existing functionality
+  - [ ] Test {{existing feature 1}} still works
+  - [ ] Verify {{integration point}} behavior unchanged
+  - [ ] Check performance impact
+
+- [ ] Task 4: Add tests
+  - [ ] Unit tests following {{project test pattern}}
+  - [ ] Integration test for {{integration point}}
+  - [ ] Update existing tests if needed
+```
+
+### 5. Risk Assessment and Mitigation
+
+[[LLM: CRITICAL for brownfield - always include risk assessment]]
+
+Add section for brownfield-specific risks:
+
+```markdown
+## Risk Assessment
+
+### Implementation Risks
+- **Primary Risk**: {{main risk to existing system}}
+- **Mitigation**: {{how to address}}
+- **Verification**: {{how to confirm safety}}
+
+### Rollback Plan
+- {{Simple steps to undo changes if needed}}
+
+### Safety Checks
+- [ ] Existing {{feature}} tested before changes
+- [ ] Changes can be feature-flagged or isolated
+- [ ] Rollback procedure documented
+```
+
+### 6. Final Story Validation
+
+Before finalizing:
+
+1. **Completeness Check**:
+   - [ ] Story has clear scope and acceptance criteria
+   - [ ] Technical context is sufficient for implementation
+   - [ ] Integration approach is defined
+   - [ ] Risks are identified with mitigation
+
+2. **Safety Check**:
+   - [ ] Existing functionality protection included
+   - [ ] Rollback plan is feasible
+   - [ ] Testing covers both new and existing features
+
+3. **Information Gaps**:
+   - [ ] All critical missing information gathered from user
+   - [ ] Remaining unknowns documented for dev agent
+   - [ ] Exploration tasks added where needed
+
+### 7. Story Output Format
+
+Save the story with appropriate naming:
+
+- If from epic: `docs/stories/epic-{n}-story-{m}.md`
+- If standalone: `docs/stories/brownfield-{feature-name}.md`
+- If sequential: Follow existing story numbering
+
+Include header noting documentation context:
+
+```markdown
+# Story: {{Title}}
+
+<!-- Source: {{documentation type used}} -->
+<!-- Context: Brownfield enhancement to {{existing system}} -->
+
+## Status: Draft
+[Rest of story content...]
+```
+
+### 8. Handoff Communication
+
+Provide clear handoff to the user:
+
+```text
+Brownfield story created: {{story title}}
+
+Source Documentation: {{what was used}}
+Story Location: {{file path}}
+
+Key Integration Points Identified:
+- {{integration point 1}}
+- {{integration point 2}}
+
+Risks Noted:
+- {{primary risk}}
+
+{{If missing info}}: 
+Note: Some technical details were unclear. The story includes exploration tasks to gather needed information during implementation.
+
+Next Steps:
+1. Review story for accuracy
+2. Verify integration approach aligns with your system
+3. Approve story or request adjustments
+4. Dev agent can then implement with safety checks
+```
+
+### 9. Update Workflow Plan (if applicable)
+
+[[LLM: After successful story creation]]
+
+- If workflow plan tracking is enabled and story was created successfully:
+  - Call update-workflow-plan task to mark step complete
+  - Parameters: task: create-brownfield-story, step_id: {from plan check}, status: complete
+  - If plan shows next recommended step, include it in handoff message
+
+## Success Criteria
+
+The brownfield story creation is successful when:
+
+1. Story can be implemented without requiring dev to search multiple documents
+2. Integration approach is clear and safe for existing system
+3. All available technical context has been extracted and organized
+4. Missing information has been identified and addressed
+5. Risks are documented with mitigation strategies
+6. Story includes verification of existing functionality
+7. Rollback approach is defined
+
+## Important Notes
+
+- This task is specifically for brownfield projects with non-standard documentation
+- Always prioritize existing system safety over new features
+- When in doubt, add exploration and verification tasks
+- It's better to ask the user for clarification than make assumptions
+- Each story should be self-contained for the dev agent
+- Include references to existing code patterns when available

package/bmad-core/tasks/create-next-story.md

@@ -26,6 +26,22 @@ To identify the next logical story based on project progress and epic definition
   - `architecture.architectureSharded`: Whether architecture is sharded
   - `architecture.architectureFile`: Location of monolithic architecture
   - `architecture.architectureShardedLocation`: Location of sharded architecture files
+  - `workflow.trackProgress`: Whether workflow plan tracking is enabled
+  - `workflow.planFile`: Location of workflow plan (if tracking enabled)
+
+### 0.5 Check Workflow Plan (if configured)
+
+[[LLM: Check if workflow plan tracking is enabled]]
+
+- If `workflow.trackProgress: true`, check for active plan at `workflow.planFile`
+- If plan exists:
+  - Parse plan to check if story creation is the expected next step
+  - If out of sequence and `workflow.enforceSequence: true`:
+    - Show warning: "The workflow plan indicates you should complete {expected_step} before creating stories."
+    - Block execution unless user explicitly overrides
+  - If out of sequence and `workflow.enforceSequence: false`:
+    - Show warning but allow continuation with confirmation
+- Continue with story identification after plan check
 
 ### 1. Identify Next Story for Preparation
 
@@ -249,4 +265,13 @@ Provide a summary to the user including:
 - Recommendations for story review before approval
 - Next steps: Story should be reviewed by PO for approval before dev work begins
 
+### 10. Update Workflow Plan (if applicable)
+
+[[LLM: After successful story creation]]
+
+- If `workflow.trackProgress: true` and `workflow.updateOnCompletion: true`:
+  - Call update-workflow-plan task to mark story creation step complete
+  - Parameters: task: create-next-story, step_id: {from plan}, status: complete
+  - If plan shows next step, mention it in completion message
+
 [[LLM: Remember - The success of this task depends on extracting real, specific technical details from the architecture shards. The dev agent should have everything they need in the story file without having to search through multiple documents.]]