✨ Documentation Strategy: - Keep BMAD core documentation unchanged (easier upstream sync) - Add Production QA as enhancement, not replacement - Create comprehensive Production QA Guide in docs/ - Simplify main README with clear choice between approaches 📖 New Documentation: - docs/production-qa-guide.md - Complete guide with 11 sections - Covers agents, workflows, tools, quality gates, CI/CD - Migration guide from traditional to Production QA - Troubleshooting and best practices 🎯 Key Improvements: - Position as 'enhancement' not 'replacement' - Clear comparison table (Traditional vs Production) - Tool-agnostic approach emphasized - Parallel workflow benefits highlighted This approach preserves BMAD integrity while showcasing Production QA value 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| bmad-core | ||
| common | ||
| dist | ||
| docs | ||
| expansion-packs | ||
| tools | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| PR-opencode-agents-generator.md | ||
| README.md | ||
| eslint.config.mjs | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.mjs | ||
README.md
BMAD-METHOD™: Universal AI Agent Framework
Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, yet so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.
🧪 This fork includes the Production QA Expansion Pack - Enterprise-grade testing automation with specialized QA agents, automated quality gates, and comprehensive test coverage. Works alongside traditional BMAD workflow. Learn more →
Subscribe to BMadCode on YouTube
Join our Discord Community - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you! Some mobile and VPN may have issue joining the discord, this is a discord issue - if the invite does not work, try from your own internet or another network, or non-VPN.
⭐ If you find this project helpful or useful, please give it a star in the upper right hand corner! It helps others discover BMAD-METHOD™ and you will be notified of updates!
Overview
BMAD-METHOD™'s Three Key Innovations:
1. Agentic Planning: Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
2. Context-Engineered Development: The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.
3. Production-Ready QA Integration: Specialized QA agents create comprehensive test suites in parallel with development, implementing automated quality gates, performance validation, security scanning, and accessibility testing - ensuring enterprise-grade quality without slowing development velocity.
This three-phase approach eliminates planning inconsistency, context loss, and quality gaps - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why, while QA agents ensure production readiness.
📖 See the complete workflow in the User Guide - Planning phase, development cycle, and all agent roles
Quick Navigation
Understanding the BMad Workflow
Before diving in, review these critical workflow diagrams that explain how BMad works:
- Planning Workflow (Web UI) - How to create PRD and Architecture documents
- Core Development Cycle (IDE) - How SM, Dev, and QA agents collaborate through story files
⚠️ These diagrams explain 90% of BMad Method Agentic Agile flow confusion - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!
🆕 Choose Your Development Approach:
- Traditional BMAD - Rapid prototyping with advisory QA (original workflow)
- Production QA Enhanced - Enterprise-grade with automated testing (see enhanced workflow)
What would you like to do?
- Install and Build software with Full Stack Agile AI Team → Quick Start Instruction
- 🧪 Use Production QA Testing → Enterprise-grade testing automation
- Learn how to use BMad → Complete user guide and walkthrough
- See available AI agents → Specialized roles for your team
- Explore non-technical uses → Creative writing, business, wellness, education
- Create my own AI agents → Build agents for your domain
- Browse ready-made expansion packs → Game dev, DevOps, infrastructure, Production QA, and get inspired with ideas and examples
- Understand the architecture → Technical deep dive
- Join the community → Get help and share ideas
Important: Keep Your BMad Installation Updated
Stay up-to-date effortlessly! If you already have BMAD-METHOD™ installed in your project, simply run:
npx bmad-method install
# OR
git pull
npm run install:bmad
This will:
- ✅ Automatically detect your existing v4 installation
- ✅ Update only the files that have changed and add new files
- ✅ Create
.bakbackup files for any custom modifications you've made - ✅ Preserve your project-specific configurations
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
Quick Start
One Command for Everything (IDE Installation)
Just run one of these commands:
npx bmad-method install
# OR if you already have BMad installed:
git pull
npm run install:bmad
This single command handles:
- New installations - Sets up BMad in your project
- Upgrades - Updates existing installations automatically
- Expansion packs - Installs any expansion packs you've added to package.json
That's it! Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
Prerequisites: Node.js v20+ required
Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
- Get the bundle: Save or clone the full stack team file or choose another team
- Create AI agent: Create a new Gemini Gem or CustomGPT
- Upload & configure: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
- Start Ideating and Planning: Start chatting! Type
*helpto see available commands or pick an agent like*analystto start right in on creating a brief. - CRITICAL: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
- When to move to the IDE: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the User guide for more details
Alternative: Clone and Build
git clone https://github.com/bmadcode/bmad-method.git
npm run install:bmad # build and install all to a destination folder
🧪 Production QA Enhancement
This fork includes Production QA - enterprise-grade testing automation that works alongside traditional BMAD.
Quick Overview
- ✅ 4 Specialized QA Agents - Test Engineer, Performance, Security, Test Lead
- ✅ Automated Testing - E2E, API, Performance, Security tests
- ✅ Quality Gates - Automated pass/fail criteria
- ✅ Tool Agnostic - Works with any testing framework
- ✅ Parallel Workflow - QA creates tests while Dev implements
Choose Your Approach
- Traditional BMAD - Rapid prototyping with advisory QA
- Production QA - Enterprise applications with automated testing
📖 Complete Production QA Guide - Everything you need to know about Production QA
🌟 Beyond Software Development - Expansion Packs
BMAD™'s natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMAD-METHOD™ with specific functionality that is not generic for all cases. See the Expansion Packs Guide and learn to create your own!
Documentation & Resources
Essential Guides
- 📖 User Guide - Complete walkthrough from project inception to completion
- 🏗️ Core Architecture - Technical deep dive and system design
- 🚀 Expansion Packs Guide - Extend BMad to any domain beyond software development
Support
Contributing
We're excited about contributions and welcome your ideas, improvements, and expansion packs! 🎉
📋 Read CONTRIBUTING.md - Complete guide to contributing, including guidelines, process, and requirements
Working with Forks
When you fork this repository, CI/CD workflows are disabled by default to save resources. This is intentional and helps keep your fork clean.
Need CI/CD in Your Fork?
See our Fork CI/CD Guide for instructions on enabling workflows in your fork.
Contributing Workflow
- Fork the repository - Click the Fork button on GitHub
- Clone your fork -
git clone https://github.com/YOUR-USERNAME/BMAD-METHOD.git - Create a feature branch -
git checkout -b feature/amazing-feature - Make your changes - Test locally with
npm test - Commit your changes -
git commit -m 'feat: add amazing feature' - Push to your fork -
git push origin feature/amazing-feature - Open a Pull Request - CI/CD will run automatically on the PR
Your contributions are tested when you submit a PR - no need to enable CI in your fork!
License
MIT License - see LICENSE for details.
Trademark Notice
BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
Built with ❤️ for the AI-assisted development community