bmad-method 4.30.3 → 4.31.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.
@@ -1,42 +0,0 @@
1
- # BMad Method Guide for GitHub Copilot
2
-
3
- For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
4
-
5
- ## Installation
6
-
7
- When running `npx bmad-method install`, select **GitHub Copilot** as your IDE. This command will perform the following actions:
8
-
9
- - Create the `.bmad-core/` directory with all the agent rule files.
10
- - Create the `.vscode/` directory and add a `settings.json` file if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode.
11
- - Create a chatmodes file under your .github folder for each specific agent being added
12
-
13
- ## Using BMAD Agents in GitHub Copilot
14
-
15
- 1. **Open GitHub Copilot chat** in VS Code (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux).
16
- 2. Select the agent you want to use from the chat input's participant selector (e.g., `@workspace` > `dev`).
17
- 3. The agent adopts that persona for the conversation.
18
- 4. Use `*help` to see the commands available for the selected agent.
19
-
20
- ## Available Agents
21
-
22
- You can switch between agents using the chat participant selector. The following agents are available for GitHub Copilot:
23
-
24
- - `bmad-master` - Master Task Executor
25
- - `dev` - Development expert
26
- - `qa` - Quality Assurance specialist
27
- - `ux-expert` - UX specialist
28
-
29
- ## GitHub Copilot-Specific Features
30
-
31
- - **Settings**: Use the `.vscode/settings.json` file to configure Copilot behavior. The installer can configure these for you.
32
- - `chat.agent.maxRequests`: Maximum requests per agent session (recommended: 15).
33
- - `github.copilot.chat.agent.runTasks`: Allow agents to run workspace tasks (e.g., from `package.json` scripts).
34
- - `github.copilot.chat.agent.autoFix`: Enable automatic error detection and fixing in generated code.
35
- - `chat.tools.autoApprove`: Auto-approve ALL tools without confirmation (use with caution).
36
- - **VS Code integration**: Works within VS Code's GitHub Copilot chat panel.
37
- - **Tool Confirmation**: Copilot will ask for confirmation before running tools that can modify files. You can approve a tool once, for the session, or always.
38
-
39
- ## Tips for GitHub Copilot Users
40
-
41
- - You can use a `.github/copilot-instructions.md` file to provide additional context or instructions for your projects that are not covered by the BMAD framework.
42
- - BMAD agents can come with a pre-configured set of tools. You can see which tools an agent uses by looking at the `tools` section in its `.github/chatmodes/[agent].chatmode.md` file.
@@ -1,15 +0,0 @@
1
- # BMad Method Guide for Roo Code
2
-
3
- For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
4
-
5
- ## Installation
6
-
7
- When running `npx bmad-method install`, select **Roo Code** as your IDE. This creates:
8
-
9
- - `.bmad-core/` folder with all agents
10
- - `.roomodes` file in project root with custom modes
11
-
12
- ## Roo Code-Specific Features
13
-
14
- - **Mode file**: `.roomodes` in project root
15
- - **Mode switching**: Use mode selecto
@@ -1,14 +0,0 @@
1
- # BMad Method Guide for Trae
2
-
3
- For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
4
-
5
- ## Installation
6
-
7
- When running `npx bmad-method install`, select **Trae** as your IDE. This creates:
8
-
9
- - `.bmad-core/` folder with all agents
10
- - `.trae/rules/` folder with agent rule files (`.md`)
11
-
12
- ## Using BMad Agents in Trae
13
-
14
- Type `@agent-name` in chat to activate an agent.
@@ -1,14 +0,0 @@
1
- # BMad Method Guide for Windsurf
2
-
3
- For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
4
-
5
- ## Installation
6
-
7
- When running `npx bmad-method install`, select **Windsurf** as your IDE. This creates:
8
-
9
- - `.bmad-core/` folder with all agents
10
- - `.windsurf/rules/` folder with agent rule files (`.md`)
11
-
12
- ## Using BMad Agents in Windsurf
13
-
14
- Type `@agent-name` in chat to activate an agent.
@@ -1,166 +0,0 @@
1
- # BMad Method Universal Workflow Guide
2
-
3
- This guide outlines the core BMad workflow that applies regardless of which AI-powered IDE you're using.
4
-
5
- ## Overview
6
-
7
- The BMad Method follows a structured approach to AI-assisted software development:
8
-
9
- 1. **Install BMad** in your project
10
- 2. **Plan with Gemini** using team-fullstack
11
- 3. **Organize with bmad-master** (document sharding)
12
- 4. **Develop iteratively** with SM → Dev cycles
13
-
14
- ## The Complete Workflow
15
-
16
- ### Phase 1: Project Setup
17
-
18
- 1. **Install BMad in your project**:
19
-
20
- ```bash
21
- npx bmad-method install
22
- ```
23
-
24
- - Choose "Complete installation"
25
- - Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or GitHub Copilot)
26
-
27
- 2. **Verify installation**:
28
- - `.bmad-core/` folder created with all agents
29
- - IDE-specific integration files created
30
- - All agent commands/rules/modes available
31
-
32
- ### Phase 2: Ideation & Planning (Gemini)
33
-
34
- Use Google's Gemini for collaborative planning with the full team:
35
-
36
- 1. **Open [Google Gems](https://gemini.google.com/gems/view)**
37
- 2. **Create a new Gem**:
38
- - Give it a title and description (e.g., "BMad Team Fullstack")
39
- 3. **Load team-fullstack**:
40
- - Copy contents of: `web-bundles/teams/team-fullstack.txt` from your project
41
- - Paste this content into the Gem setup to configure the team
42
- 4. **Collaborate with the team**:
43
- - Business Analyst: Requirements gathering
44
- - Product Manager: Feature prioritization
45
- - Solution Architect: Technical design
46
- - UX Expert: User experience design
47
-
48
- ### Example Gemini Sessions:
49
-
50
- ```text
51
- "I want to build a [type] application that [core purpose].
52
- Help me brainstorm features and create a comprehensive PRD."
53
-
54
- "Based on this PRD, design a scalable technical architecture
55
- that can handle [specific requirements]."
56
- ```
57
-
58
- 5. **Export planning documents**:
59
- - Copy the PRD output and save as `docs/prd.md` in your project
60
- - Copy the architecture output and save as `docs/architecture.md` in your project
61
-
62
- ### Phase 3: Document Organization (IDE)
63
-
64
- Switch back to your IDE for document management:
65
-
66
- 1. **Load bmad-master agent** (syntax varies by IDE)
67
- 2. **Shard the PRD**:
68
- ```
69
- *shard-doc docs/prd.md prd
70
- ```
71
- 3. **Shard the architecture**:
72
- ```
73
- *shard-doc docs/architecture.md architecture
74
- ```
75
-
76
- **Result**: Organized folder structure:
77
-
78
- - `docs/prd/` - Broken down PRD sections
79
- - `docs/architecture/` - Broken down architecture sections
80
-
81
- ### Phase 4: Iterative Development
82
-
83
- Follow the SM → Dev cycle for systematic story development:
84
-
85
- #### Story Creation (Scrum Master)
86
-
87
- 1. **Start new chat/conversation**
88
- 2. **Load SM agent**
89
- 3. **Execute**: `*create` (runs create-next-story task)
90
- 4. **Review generated story** in `docs/stories/`
91
- 5. **Update status**: Change from "Draft" to "Approved"
92
-
93
- #### Story Implementation (Developer)
94
-
95
- 1. **Start new chat/conversation**
96
- 2. **Load Dev agent**
97
- 3. **Agent asks**: Which story to implement
98
- 4. **Follow development tasks**
99
- 5. **Complete implementation**
100
- 6. **Update status**: Change to "Done"
101
-
102
- #### Repeat Until Complete
103
-
104
- - **SM**: Create next story → Review → Approve
105
- - **Dev**: Implement story → Complete → Mark done
106
- - **Continue**: Until all features implemented
107
-
108
- ## IDE-Specific Syntax
109
-
110
- ### Agent Loading Syntax by IDE:
111
-
112
- - **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
113
- - **Cursor**: `@agent-name` (e.g., `@bmad-master`)
114
- - **Gemini CLI**: `*agent-name` (e.g., `*bmad-master`)
115
- - **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
116
- - **Trae**: `@agent-name` (e.g., `@bmad-master`)
117
- - **Roo Code**: Select mode from mode selector (e.g., `bmad-master`)
118
- - **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
119
-
120
- ### Chat Management:
121
-
122
- - **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
123
- - **Roo Code**: Switch modes within the same conversation
124
-
125
- ## Available Agents
126
-
127
- ### Core Development Agents:
128
-
129
- - **bmad-master**: Universal task executor, document management
130
- - **sm**: Scrum Master for story creation and agile process
131
- - **dev**: Full-stack developer for implementation
132
- - **architect**: Solution architect for technical design
133
-
134
- ### Specialized Agents:
135
-
136
- - **pm**: Product manager for planning and prioritization
137
- - **analyst**: Business analyst for requirements
138
- - **qa**: QA specialist for testing strategies
139
- - **po**: Product owner for backlog management
140
- - **ux-expert**: UX specialist for design
141
-
142
- ## Key Principles
143
-
144
- 1. **Agent Specialization**: Each agent has specific expertise and responsibilities
145
- 2. **Clean Handoffs**: Always start fresh when switching between agents
146
- 3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
147
- 4. **Iterative Development**: Complete one story before starting the next
148
- 5. **Documentation First**: Always start with solid PRD and architecture
149
-
150
- ## Common Commands
151
-
152
- Every agent supports these core commands:
153
-
154
- - `*help` - Show available commands
155
- - `*status` - Show current context/progress
156
- - `*exit` - Exit the agent mode
157
-
158
- ## Success Tips
159
-
160
- - **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
161
- - **Use bmad-master for document organization** - Sharding creates manageable chunks
162
- - **Follow the SM → Dev cycle religiously** - This ensures systematic progress
163
- - **Keep conversations focused** - One agent, one task per conversation
164
- - **Review everything** - Always review and approve before marking complete
165
-
166
- This workflow ensures systematic, AI-assisted development following agile principles with clear separation of concerns and consistent progress tracking.