mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
Style Guide Additions: - Add Reference Structure section with 6 document types (Index, Catalog, Deep-Dive, Configuration, Glossary, Comprehensive) - Add Glossary Structure section with table-based format leveraging Starlight's right-nav for navigation - Include checklists for both new document types Reference Docs Updated: - agents/index.md: Catalog format, universal commands tip admonition - configuration/core-tasks.md: Configuration format with admonitions - configuration/global-config.md: Table-based config reference - workflows/index.md: Minimal index format - workflows/core-workflows.md: Catalog format - workflows/document-project.md: Deep-dive with Quick Facts admonition - workflows/bmgd-workflows.md: Comprehensive format, removed ~30 hr rules Glossary Rewritten: - Converted from 373 lines with ### headers to 123 lines with tables - Right nav now shows 9 categories instead of 50+ terms - Added italic context markers (*BMGD.*, *Brownfield.*, etc.) - Alphabetized terms within categories - Removed redundant inline TOC All Docs: - Remove horizontal rules (---) per style guide - Remove "Related" sections (sidebar handles navigation) - Standardize admonition usage - Archive deleted workflow customization docs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2.1 KiB
2.1 KiB
title, description
| title | description |
|---|---|
| How to Add a Feature to an Existing Project | How to add new features to an existing brownfield project |
Use the workflow-init workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture.
When to Use This
- Adding a new feature to an existing codebase
- Major enhancements that need proper planning
- Features that touch multiple parts of the system
:::note[Prerequisites]
- BMad Method installed
- Existing project documentation (run
document-projectfirst if needed) - Clear understanding of what you want to build :::
Steps
1. Run workflow-init
Run workflow-init
The workflow should recognize you're in an existing project. If not, explicitly clarify that this is brownfield development.
2. Choose Your Approach
| Feature Scope | Recommended Approach |
|---|---|
| Small (1-5 stories) | Quick Flow with tech-spec |
| Medium (5-15 stories) | BMad Method with PRD |
| Large (15+ stories) | Full BMad Method with architecture |
3. Create Planning Documents
For Quick Flow:
- Load PM agent
- Run tech-spec workflow
- The agent will analyze your existing codebase and create a context-aware spec
For BMad Method:
- Load PM agent
- Run PRD workflow
- Ensure the agent reads your existing documentation
- Review that integration points are clearly identified
4. Consider Architecture Impact
If your feature affects system architecture:
- Load Architect agent
- Run architecture workflow
- Ensure alignment with existing patterns
- Document any new ADRs (Architecture Decision Records)
5. Implement
Follow the standard Phase 4 implementation workflows:
sprint-planning- Organize your workcreate-story- Prepare each storydev-story- Implement with testscode-review- Quality assurance
Tips
- Always ensure agents read your existing documentation
- Pay attention to integration points with existing code
- Follow existing conventions unless deliberately changing them
- Document why you're adding new patterns (if any)