bmad-method 5.0.0 → 5.0.1

package/docs/expansion-packs.md

@@ -0,0 +1,280 @@
+# The Power of BMad Expansion Packs
+
+## Overview
+
+BMad Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMad into a universal AI agent system.
+
+## Why Expansion Packs?
+
+### Keep Core Lean
+
+The core BMad framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
+
+### Domain Expertise
+
+Each expansion pack provides deep, specialized knowledge without bloating the core system. Install only what you need.
+
+### Community Innovation
+
+Anyone can create and share expansion packs, fostering a ecosystem of AI-powered solutions across all industries and interests.
+
+## Technical Expansion Packs
+
+### Game Development Pack
+
+Transform your AI into a complete game development studio:
+
+- **Game Designer**: Mechanics, balance, progression systems
+- **Level Designer**: Map layouts, puzzle design, difficulty curves
+- **Narrative Designer**: Story arcs, dialog trees, lore creation
+- **Art Director**: Visual style guides, asset specifications
+- **Sound Designer**: Audio direction, music themes, SFX planning
+
+### Mobile Development Pack
+
+Specialized agents for mobile app creation:
+
+- **iOS Specialist**: Swift/SwiftUI patterns, Apple guidelines
+- **Android Expert**: Kotlin best practices, Material Design
+- **Mobile UX Designer**: Touch interfaces, gesture patterns
+- **App Store Optimizer**: ASO strategies, listing optimization
+- **Performance Tuner**: Battery optimization, network efficiency
+
+### DevOps/Infrastructure Pack
+
+Complete infrastructure automation team:
+
+- **Cloud Architect**: AWS/Azure/GCP design patterns
+- **Security Specialist**: Zero-trust implementation, compliance
+- **SRE Expert**: Monitoring, alerting, incident response
+- **Container Orchestrator**: Kubernetes, Docker optimization
+- **Cost Optimizer**: Cloud spend analysis, resource right-sizing
+
+### Data Science Pack
+
+AI-powered data analysis team:
+
+- **Data Scientist**: Statistical analysis, ML model selection
+- **Data Engineer**: Pipeline design, ETL processes
+- **ML Engineer**: Model deployment, A/B testing
+- **Visualization Expert**: Dashboard design, insight communication
+- **Ethics Advisor**: Bias detection, fairness assessment
+
+## Non-Technical Expansion Packs
+
+### Business Strategy Pack
+
+Complete business advisory team:
+
+- **Strategy Consultant**: Market positioning, competitive analysis
+- **Financial Analyst**: Projections, unit economics, funding strategies
+- **Operations Manager**: Process optimization, efficiency improvements
+- **Marketing Strategist**: Go-to-market plans, growth hacking
+- **HR Advisor**: Talent strategies, culture building
+
+### Creative Writing Pack
+
+Your personal writing team:
+
+- **Plot Architect**: Three-act structure, story beats, pacing
+- **Character Psychologist**: Deep motivations, authentic dialog
+- **World Builder**: Consistent universes, cultural systems
+- **Editor**: Style consistency, grammar, flow
+- **Beta Reader**: Feedback simulation, plot hole detection
+
+### Health & Wellness Pack
+
+Personal wellness coaching system:
+
+- **Fitness Trainer**: Progressive overload, form correction
+- **Nutritionist**: Macro planning, supplement guidance
+- **Sleep Coach**: Circadian optimization, sleep hygiene
+- **Stress Manager**: Coping strategies, work-life balance
+- **Habit Engineer**: Behavior change, accountability systems
+
+### Education Pack
+
+Complete learning design system:
+
+- **Curriculum Architect**: Learning objectives, scope & sequence
+- **Instructional Designer**: Engagement strategies, multimedia learning
+- **Assessment Specialist**: Rubrics, formative/summative evaluation
+- **Differentiation Expert**: Adaptive learning, special needs
+- **EdTech Integrator**: Tool selection, digital pedagogy
+
+### Mental Health Support Pack
+
+Therapeutic support system:
+
+- **CBT Guide**: Cognitive restructuring, thought challenging
+- **Mindfulness Teacher**: Meditation scripts, awareness exercises
+- **Journal Therapist**: Reflective prompts, emotional processing
+- **Crisis Support**: Coping strategies, safety planning
+- **Habit Tracker**: Mood monitoring, trigger identification
+
+### Legal Assistant Pack
+
+Legal document and research support:
+
+- **Contract Analyst**: Term review, risk assessment
+- **Legal Researcher**: Case law, precedent analysis
+- **Document Drafter**: Template customization, clause libraries
+- **Compliance Checker**: Regulatory alignment, audit prep
+- **IP Advisor**: Patent strategies, trademark guidance
+
+### Real Estate Pack
+
+Property investment and management:
+
+- **Market Analyst**: Comparable analysis, trend prediction
+- **Investment Calculator**: ROI modeling, cash flow analysis
+- **Property Manager**: Tenant screening, maintenance scheduling
+- **Flip Strategist**: Renovation ROI, project planning
+- **Agent Assistant**: Listing optimization, showing prep
+
+### Personal Development Pack
+
+Complete personal growth system:
+
+- **Life Coach**: Guides personal growth and transformation
+- **Goal Strategist**: Helps achieve objectives with SMART goals
+- **Habit Builder**: Creates lasting habits with accountability
+- **Mindset Mentor**: Develops positive thinking patterns
+
+Key tasks include:
+
+- `goal-setting`: Defines SMART goals with action plans
+- `habit-tracking`: Monitors habit formation progress
+- `reflection-exercise`: Facilitates deep self-reflection
+
+## Unique & Innovative Packs
+
+### Role-Playing Game Master Pack
+
+AI-powered tabletop RPG assistance:
+
+- **World Master**: Dynamic world generation, NPC creation
+- **Combat Referee**: Initiative tracking, rule clarification
+- **Story Weaver**: Plot hooks, side quests, consequences
+- **Character Builder**: Backstory generation, stat optimization
+- **Loot Master**: Treasure generation, magic item creation
+
+### Life Event Planning Pack
+
+Major life event coordination:
+
+- **Wedding Planner**: Vendor coordination, timeline creation
+- **Event Designer**: Theme development, decoration plans
+- **Budget Manager**: Cost tracking, vendor negotiation
+- **Guest Coordinator**: RSVP tracking, seating arrangements
+- **Timeline Keeper**: Day-of scheduling, contingency planning
+
+### Hobby Mastery Pack
+
+Deep dive into specific hobbies:
+
+- **Garden Designer**: Plant selection, seasonal planning
+- **Brew Master**: Recipe formulation, process optimization
+- **Maker Assistant**: 3D printing, woodworking, crafts
+- **Collection Curator**: Organization, valuation, trading
+- **Photography Coach**: Composition, lighting, post-processing
+
+### Scientific Research Pack
+
+Research acceleration tools:
+
+- **Literature Reviewer**: Paper summarization, gap analysis
+- **Hypothesis Generator**: Research question formulation
+- **Methodology Designer**: Experiment planning, control design
+- **Statistical Advisor**: Test selection, power analysis
+- **Grant Writer**: Proposal structure, impact statements
+
+## Creating Your Own Expansion Pack
+
+### Step 1: Define Your Domain
+
+What expertise are you capturing? What problems will it solve?
+
+### Step 2: Design Your Agents
+
+Each agent should have:
+
+- Clear expertise area
+- Specific personality traits
+- Defined capabilities
+- Knowledge boundaries
+
+### Step 3: Create Tasks
+
+Tasks should be:
+
+- Step-by-step procedures
+- Reusable across scenarios
+- Clear and actionable
+- Domain-specific
+
+### Step 4: Build Templates
+
+Templates need:
+
+- Structured output format
+- Embedded LLM instructions
+- Placeholders for customization
+- Professional formatting
+
+### Step 5: Test & Iterate
+
+- Use with real scenarios
+- Gather user feedback
+- Refine agent responses
+- Improve task clarity
+
+### Step 6: Package & Share
+
+- Create clear documentation
+- Include usage examples
+- Add to expansion-packs directory
+- Share with community
+
+## The Future of Expansion Packs
+
+### Marketplace Potential
+
+Imagine a future where:
+
+- Professional expansion packs are sold
+- Certified packs for regulated industries
+- Community ratings and reviews
+- Automatic updates and improvements
+
+### AI Agent Ecosystems
+
+Expansion packs could enable:
+
+- Cross-pack agent collaboration
+- Industry-standard agent protocols
+- Interoperable AI workflows
+- Universal agent languages
+
+### Democratizing Expertise
+
+Every expansion pack:
+
+- Makes expert knowledge accessible
+- Reduces barriers to entry
+- Enables solo entrepreneurs
+- Empowers small teams
+
+## Getting Started
+
+1. **Browse existing packs**: Check `expansion-packs/` directory
+2. **Install what you need**: Use the installer's expansion pack option
+3. **Create your own**: Use the expansion-creator pack
+4. **Share with others**: Submit PRs with new packs
+5. **Build the future**: Help shape AI-assisted work
+
+## Remember
+
+The BMad Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
+
+**What expertise will you share with the world?**

package/docs/how-to-contribute-with-pull-requests.md

@@ -0,0 +1,158 @@
+# How to Contribute with Pull Requests
+
+**New to GitHub and pull requests?** This guide will walk you through the basics step by step.
+
+## What is a Pull Request?
+
+A pull request (PR) is how you propose changes to a project on GitHub. Think of it as saying "Here are some changes I'd like to make - please review and consider adding them to the main project."
+
+## Before You Start
+
+⚠️ **Important**: Please keep your contributions small and focused! We prefer many small, clear changes rather than one massive change.
+
+**Required before submitting PRs:**
+
+- **For bug fixes**: Create an issue using the [bug report template](https://github.com/bmadcode/bmad-method/issues/new?template=bug_report.md)
+- **For new features**:
+  1. Discuss in Discord [#general-dev channel](https://discord.gg/gk8jAdXWmj)
+  2. Create an issue using the [feature request template](https://github.com/bmadcode/bmad-method/issues/new?template=feature_request.md)
+- **For large changes**: Always open an issue first to discuss alignment
+
+## Step-by-Step Guide
+
+### 1. Fork the Repository
+
+1. Go to the [BMad-Method repository](https://github.com/bmadcode/bmad-method)
+2. Click the "Fork" button in the top-right corner
+3. This creates your own copy of the project
+
+### 2. Clone Your Fork
+
+```bash
+# Replace YOUR-USERNAME with your actual GitHub username
+git clone https://github.com/YOUR-USERNAME/bmad-method.git
+cd bmad-method
+```
+
+### 3. Create a New Branch
+
+**Never work directly on the `main` branch!** Always create a new branch for your changes:
+
+```bash
+# Create and switch to a new branch
+git checkout -b fix/typo-in-readme
+# or
+git checkout -b feature/add-new-agent
+```
+
+**Branch naming tips:**
+
+- `fix/description` - for bug fixes
+- `feature/description` - for new features
+- `docs/description` - for documentation changes
+
+### 4. Make Your Changes
+
+- Edit the files you want to change
+- Keep changes small and focused on one thing
+- Test your changes if possible
+
+### 5. Commit Your Changes
+
+```bash
+# Add your changes
+git add .
+
+# Commit with a clear message
+git commit -m "Fix typo in README.md"
+```
+
+**Good commit messages:**
+
+- "Fix typo in installation instructions"
+- "Add example for new agent usage"
+- "Update broken link in docs"
+
+**Bad commit messages:**
+
+- "stuff"
+- "changes"
+- "update"
+
+### 6. Push to Your Fork
+
+```bash
+# Push your branch to your fork
+git push origin fix/typo-in-readme
+```
+
+### 7. Create the Pull Request
+
+1. Go to your fork on GitHub
+2. You'll see a green "Compare & pull request" button - click it
+3. Select the correct target branch:
+   - **`next` branch** for most contributions (features, docs, enhancements)
+   - **`main` branch** only for critical fixes
+4. Fill out the PR description using the template in CONTRIBUTING.md:
+   - **What**: 1-2 sentences describing what changed
+   - **Why**: 1-2 sentences explaining why
+   - **How**: 2-3 bullets on implementation
+   - **Testing**: How you tested
+5. Reference the related issue number (e.g., "Fixes #123")
+
+### 8. Wait for Review
+
+- A maintainer will review your PR
+- They might ask for changes
+- Be patient and responsive to feedback
+
+## What Makes a Good Pull Request?
+
+✅ **Good PRs:**
+
+- Change one thing at a time
+- Have clear, descriptive titles
+- Explain what and why in the description
+- Include only the files that need to change
+
+❌ **Avoid:**
+
+- Changing formatting of entire files
+- Multiple unrelated changes in one PR
+- Copying your entire project/repo into the PR
+- Changes without explanation
+
+## Common Mistakes to Avoid
+
+1. **Don't reformat entire files** - only change what's necessary
+2. **Don't include unrelated changes** - stick to one fix/feature per PR
+3. **Don't paste code in issues** - create a proper PR instead
+4. **Don't submit your whole project** - contribute specific improvements
+
+## Need Help?
+
+- 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj) for real-time help:
+  - **#general-dev** - Technical questions and feature discussions
+  - **#bugs-issues** - Get help with bugs before filing issues
+- 💬 Ask questions in [GitHub Discussions](https://github.com/bmadcode/bmad-method/discussions)
+- 🐛 Report bugs using the [bug report template](https://github.com/bmadcode/bmad-method/issues/new?template=bug_report.md)
+- 💡 Suggest features using the [feature request template](https://github.com/bmadcode/bmad-method/issues/new?template=feature_request.md)
+- 📖 Read the full [Contributing Guidelines](../CONTRIBUTING.md)
+
+## Example: Good vs Bad PRs
+
+### 😀 Good PR Example
+
+**Title**: "Fix broken link to installation guide"
+**Changes**: One file, one line changed
+**Description**: "The link in README.md was pointing to the wrong file. Updated to point to correct installation guide."
+
+### 😞 Bad PR Example
+
+**Title**: "Updates"
+**Changes**: 50 files, entire codebase reformatted
+**Description**: "Made some improvements"
+
+---
+
+**Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner.