Compare commits
5 Commits
d2cb27aa5a
...
c617a75bda
| Author | SHA1 | Date |
|---|---|---|
|
|
c617a75bda | |
|
|
975aea6e74 | |
|
|
f98083ba75 | |
|
|
3a24d8ffc9 | |
|
|
84a3aa57de |
|
|
@ -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 |
|
| Typo / small bug fix | Just open the PR |
|
||||||
| ------------- | ---------------------------------------------- |
|
| Feature or large change | Confirm with a maintainer on Discord **before** you start |
|
||||||
| Bug fix | An open issue (create one if it doesn't exist) |
|
|
||||||
| Feature | An open feature request issue |
|
|
||||||
| 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
|
||||||
|
|
|
||||||
|
|
@ -291,3 +291,14 @@ Run both `bmad-review-adversarial-general` and `bmad-review-edge-case-hunter` to
|
||||||
**Input:** Target folder path
|
**Input:** Target folder path
|
||||||
|
|
||||||
**Output:** `index.md` with organized file listings, relative links, and brief descriptions
|
**Output:** `index.md` with organized file listings, relative links, and brief descriptions
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 3rd Party Tools Integration: Pencil
|
||||||
|
|
||||||
|
If you are using **Pencil** within BMAD workflows for creating mockups or UI designs, it is critical that the LLM is fully aware of its existence early in the process rather than treating it merely as a nice-to-have MCP (Model Context Protocol).
|
||||||
|
|
||||||
|
**Important Guidelines for Pencil:**
|
||||||
|
- **Introduce Early:** The sooner you bring Pencil into your planning process, the better. You must specify Pencil in your tooling **before** generating the `_bmad-output/planning-artifacts/architecture.md` document.
|
||||||
|
- **Enforce Context:** Explicitly enforce the inclusion of your `.pen` (Pencil) files in the `_bmad-output/project-context.md` file.
|
||||||
|
- **Why this matters:** If you bring Pencil in after the PRD, UX, and Architecture docs are already drafted without establishing these guardrails, the AI will not integrate it smoothly and will cause avoidable course corrections during sprints.
|
||||||
|
|
|
||||||
|
|
@ -46,6 +46,10 @@ export default defineConfig({
|
||||||
title: 'BMAD Method',
|
title: 'BMAD Method',
|
||||||
tagline: 'AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.',
|
tagline: 'AI-driven agile development with specialized agents and workflows that scale from bug fixes to enterprise platforms.',
|
||||||
|
|
||||||
|
banner: {
|
||||||
|
content: 'Build your own BMad modules and share them with the community! <a href="https://bmad-builder-docs.bmad-method.org/tutorials/build-your-first-module/">Get started</a> or <a href="https://bmad-builder-docs.bmad-method.org/how-to/distribute-your-module/">submit to the marketplace</a>.',
|
||||||
|
},
|
||||||
|
|
||||||
// i18n: locale config from shared module (website/src/lib/locales.mjs)
|
// i18n: locale config from shared module (website/src/lib/locales.mjs)
|
||||||
defaultLocale: 'root',
|
defaultLocale: 'root',
|
||||||
locales,
|
locales,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue