Skip to content

Commit bf24ddf

Browse files
Brian MadisonBrian Madison
authored andcommitted
Tempalte initial commit
0 parents  commit bf24ddf

72 files changed

Lines changed: 3262 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Dependencies
2+
node_modules/
3+
pnpm-lock.yaml
4+
bun.lock
5+
deno.lock
6+
pnpm-workspace.yaml
7+
package-lock.json
8+
9+
test-output/*
10+
coverage/
11+
12+
# Logs
13+
logs/
14+
*.log
15+
npm-debug.log*
16+
17+
# Build output
18+
build/*.txt
19+
20+
# Environment variables
21+
.env
22+
23+
# System files
24+
.DS_Store
25+
Thumbs.db
26+
27+
# Development tools and configs
28+
.prettierrc
29+
30+
# ai temp or local only files
31+
CLAUDE.md
32+
.*/**
33+
34+
_bmad
35+
_bmad-output
36+
37+
# Astro / Documentation Build
38+
website/.astro/
39+
website/dist/
40+
build/

.markdownlint-cli2.yaml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# markdownlint-cli2 configuration
2+
# https://github.com/DavidAnson/markdownlint-cli2
3+
4+
ignores:
5+
- node_modules/**
6+
- test/fixtures/**
7+
- CODE_OF_CONDUCT.md
8+
- _bmad/**
9+
- _bmad*/**
10+
- .*/**
11+
- z*/**
12+
13+
# Rule configuration
14+
config:
15+
# Disable all rules by default
16+
default: false
17+
18+
# Heading levels should increment by one (h1 -> h2 -> h3, not h1 -> h3)
19+
MD001: true
20+
21+
# Duplicate sibling headings (same heading text at same level under same parent)
22+
MD024:
23+
siblings_only: true
24+
25+
# Trailing commas in headings (likely typos)
26+
MD026:
27+
punctuation: ","
28+
29+
# Bare URLs - may not render as links in all parsers
30+
# Should use <url> or [text](url) format
31+
MD034: true
32+
33+
# Spaces inside emphasis markers - breaks rendering
34+
# e.g., "* text *" won't render as emphasis
35+
MD037: true

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
registry=https://registry.npmjs.org

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22

.prettierignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Test fixtures with intentionally broken/malformed files
2+
test/fixtures/**
3+
4+
# Contributor Covenant (external standard)
5+
CODE_OF_CONDUCT.md
6+
7+
# BMAD runtime folders (user-specific, not in repo)
8+
_bmad/
9+
_bmad*/

CHANGELOG.md

Whitespace-only changes.

CONTRIBUTING.md

Lines changed: 268 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
1+
# Contributing to BMad
2+
3+
Thank you for considering contributing to the BMad project! We believe in **Human Amplification, Not Replacement** - bringing out the best thinking in both humans and AI through guided collaboration.
4+
5+
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
6+
7+
- **#bmad-development** - Technical discussions and development questions
8+
- **#suggestions-feedback** - Feature ideas and suggestions
9+
- **#report-bugs-and-issues** - Bug reports and issue discussions
10+
11+
## Our Philosophy
12+
13+
### BMad Core™: Universal Foundation
14+
15+
BMad Core empowers humans and AI agents working together in true partnership across any domain through our **C.O.R.E. Framework** (Collaboration Optimized Reflection Engine):
16+
17+
- **Collaboration**: Human-AI partnership where both contribute unique strengths
18+
- **Optimized**: The collaborative process refined for maximum effectiveness
19+
- **Reflection**: Guided thinking that helps discover better solutions and insights
20+
- **Engine**: The powerful framework that orchestrates specialized agents and workflows
21+
22+
### BMad Method™: Agile AI-Driven Development
23+
24+
The BMad Method is the flagship bmad module for agile AI-driven software development. It emphasizes thorough planning and solid architectural foundations to provide detailed context for developer agents, mirroring real-world agile best practices.
25+
26+
### Core Principles
27+
28+
**Partnership Over Automation** - AI agents act as expert coaches, mentors, and collaborators who amplify human capability rather than replace it.
29+
30+
**Bidirectional Guidance** - Agents guide users through structured workflows while users push agents with advanced prompting. Both sides actively work to extract better information from each other.
31+
32+
**Systems of Workflows** - BMad Core builds comprehensive systems of guided workflows with specialized agent teams for any domain.
33+
34+
**Tool-Agnostic Foundation** - BMad Core remains tool-agnostic, providing stable, extensible groundwork that adapts to any domain.
35+
36+
## What Makes a Good Contribution?
37+
38+
Every contribution should strengthen human-AI collaboration. Ask yourself: **"Does this make humans and AI better together?"**
39+
40+
**✅ Contributions that align:**
41+
42+
- Enhance universal collaboration patterns
43+
- Improve agent personas and workflows
44+
- Strengthen planning and context continuity
45+
- Increase cross-domain accessibility
46+
- Add domain-specific modules leveraging BMad Core
47+
48+
**❌ What detracts from our mission:**
49+
50+
- Purely automated solutions that sideline humans
51+
- Tools that don't improve the partnership
52+
- Complexity that creates barriers to adoption
53+
- Features that fragment BMad Core's foundation
54+
55+
## Before You Contribute
56+
57+
### Reporting Bugs
58+
59+
1. **Check existing issues** first to avoid duplicates
60+
2. **Consider discussing in Discord** (#report-bugs-and-issues channel) for quick help
61+
3. **Use the bug report template** when creating a new issue - it guides you through providing:
62+
- Clear bug description
63+
- Steps to reproduce
64+
- Expected vs actual behavior
65+
- Model/IDE/BMad version details
66+
- Screenshots or links if applicable
67+
4. **Indicate if you're working on a fix** to avoid duplicate efforts
68+
69+
### Suggesting Features or New Modules
70+
71+
1. **Discuss first in Discord** (#suggestions-feedback channel) - the feature request template asks if you've done this
72+
2. **Check existing issues and discussions** to avoid duplicates
73+
3. **Use the feature request template** when creating an issue
74+
4. **Be specific** about why this feature would benefit the BMad community and strengthen human-AI collaboration
75+
76+
### Before Starting Work
77+
78+
⚠️ **Required before submitting PRs:**
79+
80+
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
81+
2. **For features**: Discuss in Discord (#suggestions-feedback) AND create a feature request issue
82+
3. **For large changes**: Always open an issue first to discuss alignment
83+
84+
Please propose small, granular changes! For large or significant changes, discuss in Discord and open an issue first. This prevents wasted effort on PRs that may not align with planned changes.
85+
86+
## Pull Request Guidelines
87+
88+
### Which Branch?
89+
90+
**Submit PR's to `main` branch** (critical only):
91+
92+
- 🚨 Critical bug fixes that break basic functionality
93+
- 🔒 Security patches
94+
- 📚 Fixing dangerously incorrect documentation
95+
- 🐛 Bugs preventing installation or basic usage
96+
97+
### PR Size Guidelines
98+
99+
- **Ideal PR size**: 200-400 lines of code changes
100+
- **Maximum PR size**: 800 lines (excluding generated files)
101+
- **One feature/fix per PR**: Each PR should address a single issue or add one feature
102+
- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
103+
- **Related changes**: Even related changes should be separate PRs if they deliver independent value
104+
105+
### Breaking Down Large PRs
106+
107+
If your change exceeds 800 lines, use this checklist to split it:
108+
109+
- [ ] Can I separate the refactoring from the feature implementation?
110+
- [ ] Can I introduce the new API/interface in one PR and implementation in another?
111+
- [ ] Can I split by file or module?
112+
- [ ] Can I create a base PR with shared utilities first?
113+
- [ ] Can I separate test additions from implementation?
114+
- [ ] Even if changes are related, can they deliver value independently?
115+
- [ ] Can these changes be merged in any order without breaking things?
116+
117+
Example breakdown:
118+
119+
1. PR #1: Add utility functions and types (100 lines)
120+
2. PR #2: Refactor existing code to use utilities (200 lines)
121+
3. PR #3: Implement new feature using refactored code (300 lines)
122+
4. PR #4: Add comprehensive tests (200 lines)
123+
124+
**Note**: PRs #1 and #4 could be submitted simultaneously since they deliver independent value.
125+
126+
### Pull Request Process
127+
128+
#### New to Pull Requests?
129+
130+
If you're new to GitHub or pull requests, here's a quick guide:
131+
132+
1. **Fork the repository** - Click the "Fork" button on GitHub to create your own copy
133+
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/bmad-module-creative-intelligence-suite.git`
134+
3. **Create a new branch** - Never work on `main` directly!
135+
```bash
136+
git checkout -b fix/description
137+
# or
138+
git checkout -b feature/description
139+
```
140+
4. **Make your changes** - Edit files, keeping changes small and focused
141+
5. **Commit your changes** - Use clear, descriptive commit messages
142+
```bash
143+
git add .
144+
git commit -m "fix: correct typo in README"
145+
```
146+
6. **Push to your fork** - `git push origin fix/description`
147+
7. **Create the Pull Request** - Go to your fork on GitHub and click "Compare & pull request"
148+
149+
### PR Description Template
150+
151+
Keep your PR description concise and focused. Use this template:
152+
153+
```markdown
154+
## What
155+
156+
[1-2 sentences describing WHAT changed]
157+
158+
## Why
159+
160+
[1-2 sentences explaining WHY this change is needed]
161+
Fixes #[issue number] (if applicable)
162+
163+
## How
164+
165+
## [2-3 bullets listing HOW you implemented it]
166+
167+
-
168+
-
169+
170+
## Testing
171+
172+
[1-2 sentences on how you tested this]
173+
```
174+
175+
**Maximum PR description length: 200 words** (excluding code examples if needed)
176+
177+
### Good vs Bad PR Descriptions
178+
179+
**Bad Example:**
180+
181+
> This revolutionary PR introduces a paradigm-shifting enhancement to the system's architecture by implementing a state-of-the-art solution that leverages cutting-edge methodologies to optimize performance metrics...
182+
183+
**Good Example:**
184+
185+
> **What:** Added validation for agent dependency resolution
186+
> **Why:** Build was failing silently when agents had circular dependencies
187+
> **How:**
188+
>
189+
> - Added cycle detection in dependency-resolver.js
190+
> - Throws clear error with dependency chain
191+
> **Testing:** Tested with circular deps between 3 agents
192+
193+
### Commit Message Convention
194+
195+
Use conventional commits format:
196+
197+
- `feat:` New feature
198+
- `fix:` Bug fix
199+
- `docs:` Documentation only
200+
- `refactor:` Code change that neither fixes a bug nor adds a feature
201+
- `test:` Adding missing tests
202+
- `chore:` Changes to build process or auxiliary tools
203+
204+
Keep commit messages under 72 characters.
205+
206+
### Atomic Commits
207+
208+
Each commit should represent one logical change:
209+
210+
- **Do:** One bug fix per commit
211+
- **Do:** One feature addition per commit
212+
- **Don't:** Mix refactoring with bug fixes
213+
- **Don't:** Combine unrelated changes
214+
215+
## What Makes a Good Pull Request?
216+
217+
**Good PRs:**
218+
219+
- Change one thing at a time
220+
- Have clear, descriptive titles
221+
- Explain what and why in the description
222+
- Include only the files that need to change
223+
- Reference related issue numbers
224+
225+
**Avoid:**
226+
227+
- Changing formatting of entire files
228+
- Multiple unrelated changes in one PR
229+
- Copying your entire project/repo into the PR
230+
- Changes without explanation
231+
- Working directly on `main` branch
232+
233+
## Common Mistakes to Avoid
234+
235+
1. **Don't reformat entire files** - only change what's necessary
236+
2. **Don't include unrelated changes** - stick to one fix/feature per PR
237+
3. **Don't paste code in issues** - create a proper PR instead
238+
4. **Don't submit your whole project** - contribute specific improvements
239+
240+
## Prompt & Agent Guidelines
241+
242+
- Keep dev agents lean - they need context for coding, not documentation
243+
- Web/planning agents can be larger with more complex tasks
244+
- Everything is natural language (markdown) - no code in core framework
245+
- Use bmad modules for domain-specific features
246+
- Validate YAML schemas with `npm run validate:schemas` before committing
247+
248+
## Code of Conduct
249+
250+
By participating in this project, you agree to abide by our Code of Conduct. We foster a collaborative, respectful environment focused on building better human-AI partnerships.
251+
252+
## Need Help?
253+
254+
- 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj):
255+
- **#bmad-development** - Technical questions and discussions
256+
- **#suggestions-feedback** - Feature ideas and suggestions
257+
- **#report-bugs-and-issues** - Get help with bugs before filing issues
258+
- 🐛 Report bugs using the [bug report template](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite/issues/new?template=bug_report.md)
259+
- 💡 Suggest features using the [feature request template](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite/issues/new?template=feature_request.md)
260+
- 📖 Browse the [GitHub Discussions](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite/discussions)
261+
262+
---
263+
264+
**Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner. Together, we're building a future where humans and AI work better together.
265+
266+
## License
267+
268+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

LICENSE

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
MIT License
2+
3+
Copyright (c) 2025 BMad Code, LLC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+
23+
TRADEMARK NOTICE:
24+
BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
25+
trademarks in this software does not grant any rights to use the trademarks
26+
for any other purpose.

0 commit comments

Comments
 (0)