Skip to content

Commit c881dcc

Browse files
Brian MadisonBrian Madison
authored andcommitted
feat: Massive documentation refactor, added explanation of the new expanded role of the QA agent that will make your code quality MUCH better. 2 new diagram clearly explain the role of the pre dev ideation cycle (prd and architecture) and the details of how the dev cycle works.
1 parent 5aed8f7 commit c881dcc

32 files changed

+991
-1045
lines changed

.vscode/settings.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"cSpell.words": [
3+
"Agentic",
4+
"elicitations",
5+
"Shardable"
6+
]
7+
}

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for considering contributing to this project! This document outlines t
44

55
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
66

7-
📋 **Before contributing**, please read our [Guiding Principles](GUIDING-PRINCIPLES.md) to understand the BMAD Method's core philosophy and architectural decisions.
7+
📋 **Before contributing**, please read our [Guiding Principles](GUIDING-PRINCIPLES.md) to understand the BMad Method's core philosophy and architectural decisions.
88

99
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
1010

GUIDING-PRINCIPLES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# BMAD Method Guiding Principles
1+
# BMad Method Guiding Principles
22

3-
The BMAD Method is a natural language framework for AI-assisted software development. These principles ensure contributions maintain the method's effectiveness.
3+
The BMad Method is a natural language framework for AI-assisted software development. These principles ensure contributions maintain the method's effectiveness.
44

55
## Core Principles
66

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Brian AKA BMad AKA Bmad Code
3+
Copyright (c) 2025 Brian AKA BMad AKA BMad Code
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 161 additions & 239 deletions
Large diffs are not rendered by default.

bmad-core/agents/dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ task-execution:
5050
updates-ONLY:
5151
- "Checkboxes: [ ] not started | [-] in progress | [x] complete"
5252
- "Debug Log: | Task | File | Change | Reverted? |"
53-
- "Completion Notes: Deviations only, <50 words"
53+
- "Completion Notes: Deviations from AC or tasks during execution only, <50 words"
5454
- "Change Log: Requirement changes only"
5555
- "File List: CRITICAL - Maintain complete list of ALL files created/modified during implementation"
5656
blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config | Failing validations"

bmad-core/data/bmad-kb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -719,7 +719,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
719719
### Using Expansion Packs
720720

721721
1. **Browse Available Packs**: Check `expansion-packs/` directory
722-
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
722+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
723723
3. **Install via CLI**:
724724
```bash
725725
npx bmad-method install

dist/agents/analyst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2654,7 +2654,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
26542654
### Using Expansion Packs
26552655

26562656
1. **Browse Available Packs**: Check `expansion-packs/` directory
2657-
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
2657+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
26582658
3. **Install via CLI**:
26592659
```bash
26602660
npx bmad-method install

dist/agents/bmad-master.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9040,7 +9040,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
90409040
### Using Expansion Packs
90419041

90429042
1. **Browse Available Packs**: Check `expansion-packs/` directory
9043-
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
9043+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
90449044
3. **Install via CLI**:
90459045
```bash
90469046
npx bmad-method install

dist/agents/bmad-orchestrator.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1130,7 +1130,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
11301130
### Using Expansion Packs
11311131

11321132
1. **Browse Available Packs**: Check `expansion-packs/` directory
1133-
2. **Get Inspiration**: See `docs/expansion-pack-ideas.md` for detailed examples
1133+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
11341134
3. **Install via CLI**:
11351135
```bash
11361136
npx bmad-method install

0 commit comments

Comments
 (0)