Compare commits
4 Commits
9f4ab090b3
...
6d37f46a44
| Author | SHA1 | Date |
|---|---|---|
|
|
6d37f46a44 | |
|
|
f98083ba75 | |
|
|
3a24d8ffc9 | |
|
|
15f49b8bd4 |
|
|
@ -6,6 +6,12 @@ Thank you for considering contributing! We believe in **Human Amplification, Not
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
> **Before you write code: talk to us on [Discord](https://discord.gg/gk8jAdXWmj).**
|
||||||
|
>
|
||||||
|
> If your change adds features, restructures code, or touches more than a couple of files, **confirm with a maintainer that it fits**. A large PR out of the blue has a high chance of being closed — regardless of effort invested. A five-minute conversation can save you hours.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Our Philosophy
|
## Our Philosophy
|
||||||
|
|
||||||
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**
|
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**
|
||||||
|
|
@ -57,15 +63,10 @@ After searching, use the [feature request template](https://github.com/bmad-code
|
||||||
|
|
||||||
## Before Starting Work
|
## Before Starting Work
|
||||||
|
|
||||||
⚠️ **Required before submitting PRs:**
|
|
||||||
|
|
||||||
| Work Type | Requirement |
|
| Work Type | Requirement |
|
||||||
| ------------- | ---------------------------------------------- |
|
| ----------------------- | -------------------------------------------------------- |
|
||||||
| Bug fix | An open issue (create one if it doesn't exist) |
|
| Typo / small bug fix | Just open the PR |
|
||||||
| Feature | An open feature request issue |
|
| Feature or large change | Confirm with a maintainer on Discord **before** you start |
|
||||||
| Large changes | Discussion via issue first |
|
|
||||||
|
|
||||||
**Why?** This prevents wasted effort on work that may not align with project direction.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -83,6 +84,12 @@ Submit PRs to the `main` branch. We use trunk-based development. Every push to `
|
||||||
|
|
||||||
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
|
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
|
||||||
|
|
||||||
|
### AI-Generated Code
|
||||||
|
|
||||||
|
Given the nature of this project, we expect most contributions involve AI assistance — that's fine. What we require is **heavy human curation**. You must understand every line you're submitting, have made deliberate choices about what to include, and be able to explain your reasoning.
|
||||||
|
|
||||||
|
We will reject PRs that read like raw LLM output: bulk refactors nobody asked for, unsolicited "improvements" across many files, or changes where the submitter clearly hasn't read the existing code. Using AI to write code is normal here; using AI as a substitute for thinking is not.
|
||||||
|
|
||||||
### New to Pull Requests?
|
### New to Pull Requests?
|
||||||
|
|
||||||
1. **Fork** the repository
|
1. **Fork** the repository
|
||||||
|
|
|
||||||
|
|
@ -119,6 +119,20 @@ export default defineConfig({
|
||||||
autogenerate: { directory: 'reference' },
|
autogenerate: { directory: 'reference' },
|
||||||
},
|
},
|
||||||
// TEA docs moved to standalone module site; keep BMM sidebar focused.
|
// TEA docs moved to standalone module site; keep BMM sidebar focused.
|
||||||
|
{
|
||||||
|
label: 'BMad Ecosystem',
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ label: 'BMad Builder', link: 'https://bmad-builder-docs.bmad-method.org/', attrs: { target: '_blank' } },
|
||||||
|
{ label: 'Creative Intelligence Suite', link: 'https://cis-docs.bmad-method.org/', attrs: { target: '_blank' } },
|
||||||
|
{ label: 'Game Dev Studio', link: 'https://game-dev-studio-docs.bmad-method.org/', attrs: { target: '_blank' } },
|
||||||
|
{
|
||||||
|
label: 'Test Architect (TEA)',
|
||||||
|
link: 'https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/',
|
||||||
|
attrs: { target: '_blank' },
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
],
|
],
|
||||||
|
|
||||||
// Credits in footer
|
// Credits in footer
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue