mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
style: apply prettier and yaml formatting
Auto-formatting applied by prettier and yaml-format tools. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Brian Madison
@@ -16,9 +16,11 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
|
||||
### Phase 1: Project Setup
|
||||
|
||||
1. **Install BMAD in your project**:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, or Roo Code)
|
||||
|
||||
@@ -37,16 +39,17 @@ Use Google's Gemini for collaborative planning with the full team:
|
||||
- Paste into new Gemini chat
|
||||
3. **Collaborate with the team**:
|
||||
- Business Analyst: Requirements gathering
|
||||
- Product Manager: Feature prioritization
|
||||
- Product Manager: Feature prioritization
|
||||
- Solution Architect: Technical design
|
||||
- UX Expert: User experience design
|
||||
|
||||
### Example Gemini Sessions:
|
||||
|
||||
```text
|
||||
"I want to build a [type] application that [core purpose].
|
||||
"I want to build a [type] application that [core purpose].
|
||||
Help me brainstorm features and create a comprehensive PRD."
|
||||
|
||||
"Based on this PRD, design a scalable technical architecture
|
||||
"Based on this PRD, design a scalable technical architecture
|
||||
that can handle [specific requirements]."
|
||||
```
|
||||
|
||||
@@ -69,6 +72,7 @@ Switch back to your IDE for document management:
|
||||
```
|
||||
|
||||
**Result**: Organized folder structure:
|
||||
|
||||
- `docs/prd/` - Broken down PRD sections
|
||||
- `docs/architecture/` - Broken down architecture sections
|
||||
|
||||
@@ -77,13 +81,15 @@ Switch back to your IDE for document management:
|
||||
Follow the SM → Dev cycle for systematic story development:
|
||||
|
||||
#### Story Creation (Scrum Master)
|
||||
|
||||
1. **Start new chat/conversation**
|
||||
2. **Load SM agent**
|
||||
3. **Execute**: `*create` (runs create-next-story task)
|
||||
4. **Review generated story** in `docs/stories/`
|
||||
5. **Update status**: Change from "Draft" to "Approved"
|
||||
|
||||
#### Story Implementation (Developer)
|
||||
#### Story Implementation (Developer)
|
||||
|
||||
1. **Start new chat/conversation**
|
||||
2. **Load Dev agent**
|
||||
3. **Agent asks**: Which story to implement
|
||||
@@ -92,6 +98,7 @@ Follow the SM → Dev cycle for systematic story development:
|
||||
6. **Update status**: Change to "Done"
|
||||
|
||||
#### Repeat Until Complete
|
||||
|
||||
- **SM**: Create next story → Review → Approve
|
||||
- **Dev**: Implement story → Complete → Mark done
|
||||
- **Continue**: Until all features implemented
|
||||
@@ -99,24 +106,28 @@ Follow the SM → Dev cycle for systematic story development:
|
||||
## IDE-Specific Syntax
|
||||
|
||||
### Agent Loading Syntax by IDE:
|
||||
|
||||
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
||||
- **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`)
|
||||
|
||||
### Chat Management:
|
||||
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
- **Roo Code**: Switch modes within the same conversation
|
||||
|
||||
## Available Agents
|
||||
|
||||
### Core Development Agents:
|
||||
|
||||
- **bmad-master**: Universal task executor, document management
|
||||
- **sm**: Scrum Master for story creation and agile process
|
||||
- **dev**: Full-stack developer for implementation
|
||||
- **architect**: Solution architect for technical design
|
||||
|
||||
### Specialized Agents:
|
||||
|
||||
- **pm**: Product manager for planning and prioritization
|
||||
- **analyst**: Business analyst for requirements
|
||||
- **qa**: QA specialist for testing strategies
|
||||
@@ -134,6 +145,7 @@ Follow the SM → Dev cycle for systematic story development:
|
||||
## Common Commands
|
||||
|
||||
Every agent supports these core commands:
|
||||
|
||||
- `*help` - Show available commands
|
||||
- `*status` - Show current context/progress
|
||||
- `*exit` - Exit the agent mode
|
||||
@@ -146,4 +158,4 @@ Every agent supports these core commands:
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear separation of concerns and consistent progress tracking.
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear separation of concerns and consistent progress tracking.
|
||||
|
||||
@@ -27,17 +27,20 @@ For ideation and planning, use Google's Gemini with the team-fullstack configura
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
@@ -51,6 +54,7 @@ Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
@@ -59,13 +63,15 @@ This creates organized folders:
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load SM agent**: Type `/sm`
|
||||
2. **Load SM agent**: Type `/sm`
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load Dev agent**: Type `/dev`
|
||||
3. **The agent will ask which story to implement**
|
||||
@@ -73,6 +79,7 @@ Now begin the iterative development cycle:
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Start a new chat with SM agent** (`/sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
@@ -105,8 +112,8 @@ All BMAD agents are available as Claude Code commands:
|
||||
## Tips for Success
|
||||
|
||||
- **Keep chats focused**: Each chat should have one agent and one primary task
|
||||
- **Use *help command**: Every agent supports `*help` to see available commands
|
||||
- **Use \*help command**: Every agent supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
|
||||
@@ -27,17 +27,20 @@ For ideation and planning, use Google's Gemini with the team-fullstack configura
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
@@ -51,6 +54,7 @@ Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
@@ -59,13 +63,15 @@ This creates organized folders:
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load SM agent**: Type `@sm`
|
||||
2. **Load SM agent**: Type `@sm`
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load Dev agent**: Type `@dev`
|
||||
3. **The agent will ask which story to implement**
|
||||
@@ -73,6 +79,7 @@ Now begin the iterative development cycle:
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Start a new chat with SM agent** (`@sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
@@ -112,9 +119,9 @@ All BMAD agents are available as Cursor rules (use `@` prefix):
|
||||
## Tips for Success
|
||||
|
||||
- **Keep chats focused**: Each chat should have one agent and one primary task
|
||||
- **Use *help command**: Every agent supports `*help` to see available commands
|
||||
- **Use \*help command**: Every agent supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
- **Leverage Cursor's context**: Agents can see your current file selection for better assistance
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
|
||||
@@ -27,17 +27,20 @@ For ideation and planning, use Google's Gemini with the team-fullstack configura
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
@@ -51,6 +54,7 @@ Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
@@ -59,6 +63,7 @@ This creates organized folders:
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat or conversation**
|
||||
2. **Switch to SM mode**: Select `bmad-sm` from the mode selector
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
@@ -66,6 +71,7 @@ Now begin the iterative development cycle:
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new conversation**
|
||||
2. **Switch to Dev mode**: Select `bmad-dev` from the mode selector
|
||||
3. **The agent will ask which story to implement**
|
||||
@@ -73,6 +79,7 @@ Now begin the iterative development cycle:
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Switch to SM mode** (`bmad-sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
@@ -117,7 +124,7 @@ All BMAD agents are available as custom modes:
|
||||
|
||||
- **Use mode selector effectively**: Switch modes as needed for different tasks
|
||||
- **Respect file permissions**: Agents can only edit files they have permission for
|
||||
- **Use *help command**: Every mode supports `*help` to see available commands
|
||||
- **Use \*help command**: Every mode supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
- **Leverage Roo's context**: Modes can maintain context across the conversation
|
||||
@@ -130,4 +137,4 @@ All BMAD agents are available as custom modes:
|
||||
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx` files
|
||||
- **bmad-dev, bmad-bmad-master, bmad-orchestrator**: Full file access
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
|
||||
@@ -8,7 +8,7 @@ The easiest way to release new versions is through **automatic semantic releases
|
||||
|
||||
Use these prefixes to control what type of release happens:
|
||||
|
||||
```bash
|
||||
````bash
|
||||
fix: resolve CLI argument parsing bug # → patch release (4.1.0 → 4.1.1)
|
||||
feat: add new agent orchestration mode # → minor release (4.1.0 → 4.2.0)
|
||||
feat!: redesign CLI interface # → major release (4.1.0 → 5.0.0)
|
||||
@@ -35,13 +35,13 @@ git push
|
||||
|
||||
# That's it! Release happens automatically 🎉
|
||||
# Users can now run: npx bmad-method (and get the new version)
|
||||
```
|
||||
````
|
||||
|
||||
### Commits That DON'T Trigger Releases
|
||||
|
||||
These commit types won't create releases (use them for maintenance):
|
||||
|
||||
```bash
|
||||
````bash
|
||||
chore: update dependencies # No release
|
||||
docs: fix typo in readme # No release
|
||||
style: format code # No release
|
||||
@@ -52,7 +52,7 @@ test: add unit tests # No release
|
||||
|
||||
```bash
|
||||
npm run release:test # Safe to run locally - tests the config
|
||||
```
|
||||
````
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -27,17 +27,20 @@ For ideation and planning, use Google's Gemini with the team-fullstack configura
|
||||
### Gemini Planning Phase
|
||||
|
||||
In Gemini, ask the BMAD team to help you:
|
||||
|
||||
- **Ideate** your project concept
|
||||
- **Brainstorm** features and requirements
|
||||
- **Brainstorm** features and requirements
|
||||
- **Create a PRD** (Product Requirements Document)
|
||||
- **Design the architecture**
|
||||
|
||||
Ask questions like:
|
||||
|
||||
- "Help me brainstorm a [type of application] that does [core functionality]"
|
||||
- "Create a comprehensive PRD for this concept"
|
||||
- "Design the technical architecture for this system"
|
||||
|
||||
Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
|
||||
|
||||
- `docs/prd.md`
|
||||
- `docs/architecture.md`
|
||||
|
||||
@@ -51,6 +54,7 @@ Once you have your PRD and architecture documents in the `docs/` folder:
|
||||
4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
|
||||
|
||||
This creates organized folders:
|
||||
|
||||
- `docs/prd/` - Contains broken down PRD sections
|
||||
- `docs/architecture/` - Contains broken down architecture sections
|
||||
|
||||
@@ -59,13 +63,15 @@ This creates organized folders:
|
||||
Now begin the iterative development cycle:
|
||||
|
||||
### Create Stories (Scrum Master)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load SM agent**: Type `@sm`
|
||||
2. **Load SM agent**: Type `@sm`
|
||||
3. **Create story**: Type `*create` (this runs the create-next-story task)
|
||||
4. **Review the generated story**
|
||||
5. **If approved**: Set story status to "Approved" in the story file
|
||||
|
||||
### Implement Stories (Developer)
|
||||
|
||||
1. **Start a new chat**
|
||||
2. **Load Dev agent**: Type `@dev`
|
||||
3. **The agent will ask which story to implement**
|
||||
@@ -73,6 +79,7 @@ Now begin the iterative development cycle:
|
||||
5. **When story is complete**: Mark status as "Done"
|
||||
|
||||
### Repeat the Cycle
|
||||
|
||||
1. **Start a new chat with SM agent** (`@sm`)
|
||||
2. **Create next story**: Type `*create`
|
||||
3. **Review and approve**
|
||||
@@ -112,9 +119,9 @@ All BMAD agents are available as Windsurf rules (use `@` prefix):
|
||||
## Tips for Success
|
||||
|
||||
- **Keep chats focused**: Each chat should have one agent and one primary task
|
||||
- **Use *help command**: Every agent supports `*help` to see available commands
|
||||
- **Use \*help command**: Every agent supports `*help` to see available commands
|
||||
- **Review generated content**: Always review and approve stories before marking them ready
|
||||
- **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
|
||||
- **Leverage Windsurf's collaboration**: Use the collaborative features for team reviews
|
||||
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
|
||||
|
||||
Reference in New Issue
Block a user