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
2025-06-15 14:20:19 -05:00
parent b53d954b7a
commit c5fe28e76b
18 changed files with 168 additions and 108 deletions

View File

@@ -2,27 +2,24 @@
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage
- The customization field ALWAYS takes precedence over any conflicting instructions
- When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
agent:
name: Mary
id: analyst
title: Business Analyst
icon: 📊
whenToUse: "Use for market research, brainstorming, competitive analysis, creating project briefs, and initial project discovery"
customization:
whenToUse: Use for market research, brainstorming, competitive analysis, creating project briefs, and initial project discovery
customization: null
persona:
role: Insightful Analyst & Strategic Ideation Partner
style: Analytical, inquisitive, creative, facilitative, objective, data-informed
identity: Strategic analyst specializing in brainstorming, market research, competitive analysis, and project briefing
focus: Research planning, ideation facilitation, strategic analysis, actionable insights
core_principles:
- Curiosity-Driven Inquiry - Ask probing "why" questions to uncover underlying truths
- Objective & Evidence-Based Analysis - Ground findings in verifiable data and credible sources
@@ -35,19 +32,16 @@ persona:
- Maintaining a Broad Perspective - Stay aware of market trends and dynamics
- Integrity of Information - Ensure accurate sourcing and representation
- Numbered Options Protocol - Always use numbered lists for selections
startup:
- Greet the user with your name and role, and inform of the *help command.
commands:
- "*help" - Show: numbered list of the following commands to allow selection
- "*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation
- "*create-doc {template}" - Create doc (no template = show available templates)
- "*brainstorm {topic}" - Facilitate structured brainstorming session
- "*research {topic}" - Generate deep research prompt for investigation
- "*elicit" - Run advanced elicitation to clarify requirements
- "*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona
- '*help" - Show: numbered list of the following commands to allow selection'
- '*chat-mode" - (Default) Strategic analysis consultation with advanced-elicitation'
- '*create-doc {template}" - Create doc (no template = show available templates)'
- '*brainstorm {topic}" - Facilitate structured brainstorming session'
- '*research {topic}" - Generate deep research prompt for investigation'
- '*elicit" - Run advanced elicitation to clarify requirements'
- '*exit" - Say goodbye as the Business Analyst, and then abandon inhabiting this persona'
dependencies:
tasks:
- brainstorming-techniques

View File

@@ -2,7 +2,7 @@
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage

View File

@@ -14,11 +14,13 @@ Simple document migration that cleans up heading formats and adds epic structure
## Migration Rules
### For PRDs
- Find all level 3 headings that appear to be epics
- Add a level 2 heading "## Epic #" (incrementing number) before each epic
- Also apply the heading cleanup rules below
### For All Documents
- Find all level 2 headings (`## ...`)
- Remove leading numbers and symbols
- Keep only alphabetic characters and spaces
@@ -29,6 +31,7 @@ Simple document migration that cleans up heading formats and adds epic structure
- `## 3) User Experience``## User Experience`
### For Architecture Documents
- **PRIMARY GOAL**: Align level 2 headings to match template level 2 titles exactly
- **PRESERVE EVERYTHING**: Do not lose any information during migration
- Map existing content to the closest matching template section
@@ -37,6 +40,7 @@ Simple document migration that cleans up heading formats and adds epic structure
## Detection Logic
A document is considered a PRD if:
- Filename contains "prd" (case insensitive)
- OR main title contains "Product Requirements" or "PRD"
- OR contains sections like "User Stories", "Functional Requirements", "Acceptance Criteria"
@@ -53,6 +57,7 @@ A document is considered a PRD if:
## Epic Detection for PRDs
Level 3 headings are treated as epics if they:
- Describe features or functionality
- Are substantial sections (not just "Overview" or "Notes")
- Common epic patterns: "User Management", "Payment Processing", "Reporting Dashboard"
@@ -62,24 +67,31 @@ The epic numbering starts at 1 and increments for each epic found.
## Example
### Before (PRD):
```markdown
````markdown
# Product Requirements Document
## 1. Executive Summary
Content here...
## 2.1 Functional Requirements & Specs
Content here...
### User Management System
Epic content...
### Payment Processing
Epic content...
## 3) Success Metrics
Content here...
```text
````text
### After (PRD):
```markdown
@@ -123,4 +135,5 @@ Content...
## Technical Stack Tools
Content...
```
````
````

View File

@@ -56,7 +56,7 @@ You are now operating as a Documentation Indexer. Your goal is to ensure all doc
The index should be organized as follows:
```markdown
````markdown
# Documentation Index
## Root Documents
@@ -88,7 +88,8 @@ Documents within the `another-folder/` directory:
### [Nested Document](./another-folder/document.md)
Description of nested document.
```text
````text
### Index Entry Format
@@ -98,7 +99,8 @@ Each entry should follow this format:
### [Document Title](relative/path/to/file.md)
Brief description of the document's purpose and contents.
```
````
````
### Rules of Operation

View File

@@ -109,7 +109,7 @@ Document the choice and key services that will be used.]]
Use appropriate diagram type for clarity.]]
```mermaid
````mermaid
{{architecture_diagram}}
```text
@@ -222,7 +222,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
model_interface;
}
}
```
````
**Relationships:**
@@ -246,7 +246,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
**TypeScript Interface:**
```typescript
````typescript
interface User {
id: string;
email: string;
@@ -300,13 +300,13 @@ servers:
'[object Object]': null
description:
'[object Object]': null
```
````
^^/CONDITION: has_rest_api^^
^^CONDITION: has_graphql_api^^
```graphql
````graphql
# GraphQL Schema
{{graphql_schema}}
```text
@@ -322,7 +322,7 @@ servers:
trpc_routers;
}
}
```
````
^^/CONDITION: has_trpc_api^^
@@ -469,11 +469,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```text
{{component_structure}}
```
```text
**Component Template:**
```typescript
````typescript
{
{
component_template;
@@ -493,7 +493,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
state_structure;
}
}
```
````
**State Management Patterns:**
@@ -512,7 +512,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Protected Route Pattern:**
```typescript
````typescript
{
{
protected_route_example;
@@ -532,11 +532,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
api_client_setup;
}
}
```
````
**Service Example:**
```typescript
````typescript
{
{
service_example;
@@ -557,9 +557,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
^^CONDITION: serverless^^
**Function Organization:**
```
````
{{function_structure}}
```text
````text
**Function Template:**
@@ -569,7 +571,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
function_template;
}
}
```
````
^^/CONDITION: serverless^^
@@ -578,11 +580,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```text
{{controller_structure}}
```
```text
**Controller Template:**
```typescript
````typescript
{
{
controller_template;
@@ -600,11 +602,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```sql
{{database_schema}}
```
````
**Data Access Layer:**
```typescript
````typescript
{
{
repository_pattern;
@@ -620,11 +622,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```mermaid
{{auth_flow_diagram}}
```
````
**Middleware/Guards:**
```typescript
````typescript
{
{
auth_middleware;
@@ -690,7 +692,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
├── package.json # Root package.json
├── {{monorepo_config}} # Monorepo configuration
└── README.md
```
````
@{example: vercel_structure}
apps/
@@ -712,7 +714,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Prerequisites:**
```bash
````bash
{{prerequisites_commands}}
```text
@@ -720,11 +722,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
```bash
{{setup_commands}}
```
````
**Development Commands:**
```bash
````bash
# Start all services
{{start_all_command}}
@@ -751,7 +753,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
# Shared
{{shared_env_vars}}
```
````
## Deployment Architecture
@@ -774,7 +776,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### CI/CD Pipeline
```yml
````yaml
'[object Object]': null
```text
@@ -834,12 +836,15 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### Testing Pyramid
```
````
E2E Tests
/ \
Integration Tests
/ \
Frontend Unit Backend Unit
/ \
Frontend Unit Backend Unit
```text
### Test Organization
@@ -847,20 +852,26 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
**Frontend Tests:**
```
{{frontend_test_structure}}
```text
**Backend Tests:**
```
```text
{{backend_test_structure}}
```text
**E2E Tests:**
```
{{e2e_test_structure}}
```text
````text
### Test Examples
@@ -872,11 +883,11 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
frontend_test_example;
}
}
```
````
**Backend API Test:**
```typescript
````typescript
{
{
backend_test_example;
@@ -892,7 +903,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
e2e_test_example;
}
}
```
````
## Coding Standards
@@ -933,7 +944,7 @@ After presenting this section, apply `tasks#advanced-elicitation` protocol]]
### Error Flow
```mermaid
````mermaid
{{error_flow_diagram}}
```text
@@ -949,11 +960,11 @@ interface ApiError {
requestId: string;
};
}
```
````
### Frontend Error Handling
```typescript
````typescript
{
{
frontend_error_handler;
@@ -969,7 +980,7 @@ interface ApiError {
backend_error_handler;
}
}
```
````
## Monitoring and Observability

View File

@@ -137,7 +137,7 @@ After presenting all data models, apply `tasks#advanced-elicitation` protocol]]
**TypeScript Interface:**
```typescript
````typescript
{
{
model_interface;
@@ -183,7 +183,7 @@ interface UserProfile {
bio?: string;
preferences: Record<string, any>;
}
```
````
**Relationships:**
@@ -207,7 +207,7 @@ Use appropriate format for the chosen API style. If no API (e.g., static site),
^^CONDITION: has_rest_api^^
```yml
````yml
openapi: 3.0.0
info:
title:
@@ -230,7 +230,7 @@ servers:
```graphql
# GraphQL Schema
{{graphql_schema}}
```
````
^^/CONDITION: has_graphql_api^^

View File

@@ -6,7 +6,7 @@ When this command is used, adopt the following agent persona:
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage

View File

@@ -22,6 +22,7 @@ The `.roomodes` file defines all BMAD agents as custom modes using the proper `c
## Usage
In Roo Code:
1. Open the mode selector (usually in the status bar)
2. Select any BMAD agent mode
3. The AI will adopt that agent's personality and expertise
@@ -29,6 +30,7 @@ In Roo Code:
## File Permissions
Each agent has specific file access permissions:
- **Analysts, PM, PO, SM**: Limited to documentation files (.md, .txt)
- **Architect**: Architecture docs and configs (.md, .txt, .yml, .yaml, .json)
- **QA**: Test files and documentation

View File

@@ -6,7 +6,7 @@ This rule is triggered when the user types `@sm` and activates the Scrum Master
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage

View File

@@ -1,18 +1,16 @@
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
### Bug Fixes
* add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
* auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
* auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
* resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
* resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
- add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
- auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
- auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
- resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
- resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
### Features
* update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
- update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
# [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)

View File

@@ -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)
@@ -42,6 +44,7 @@ Use Google's Gemini for collaborative planning with the full team:
- UX Expert: User experience design
### Example Gemini Sessions:
```text
"I want to build a [type] application that [core purpose].
Help me brainstorm features and create a comprehensive PRD."
@@ -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,6 +81,7 @@ 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)
@@ -84,6 +89,7 @@ Follow the SM → Dev cycle for systematic story development:
5. **Update status**: Change from "Draft" to "Approved"
#### 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

View File

@@ -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
- **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**
2. **Load SM agent**: Type `/sm`
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 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,7 +112,7 @@ 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)

View File

@@ -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
- **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**
2. **Load SM agent**: Type `@sm`
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 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,7 +119,7 @@ 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

View File

@@ -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
- **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

View File

@@ -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
```
````
---

View File

@@ -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
- **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**
2. **Load SM agent**: Type `@sm`
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 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,7 +119,7 @@ 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

View File

@@ -2,7 +2,7 @@
CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
```yml
```yaml
activation-instructions:
- Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
- Only read the files/tasks listed here when user selects them for execution to minimize context usage

View File

@@ -33,7 +33,7 @@ installer/
## Usage
```bash
````bash
# Interactive installation
npx bmad-method install
@@ -55,4 +55,4 @@ npm test
# Lint code
npm run lint
```
````