Contribution Guidelines

Contribution Guidelines

Help make the SAE Framework the industry standard for solo, AI‑native execution.

The framework lives in two places: the repository (README, license, canonical docs) and this wiki (the living playbook). Most contributions land in the wiki.

---

What we're looking for

Area	What to add	Lands in
Tooling & stacks	New Zero‑Ops tools (UI generation, instant backends, QA agents) scored against the rubric	Approved Zero‑Ops Tooling List
Case studies	Real stories of shipping a production app solo by collapsing the 12 layers	Solo Production Case Studies
Spec templates	Reusable Markdown SDD templates for common bounded contexts	SDD Spec Template
Module refinement	Sharper explanations, diagrams, and honest Reality Checks	Modules 1–5
Glossary terms	Definitions for SAE vocabulary	Glossary

---

How to contribute

Wiki pages are edited via Git. The wiki is its own repository:

git clone https://github.com/Passion4Architecture/sae-framework.wiki.git
# edit the .md files, then
git commit -am "Add <tool/case study/section>"
git push

Repository changes (README, license, structure) go through a pull request:

1. Fork the repository.
2. Branch for your change: git checkout -b feature/sae-<topic>.
3. Commit with clear, concise messages.
4. Push and open a Pull Request against main.

---

Style guide

• Reduce human friction; maximize AI context hygiene. Every addition should serve one of those two ends.
• Bold claims are welcome — but earn them. Pair strong assertions with a Reality Check that names the limits honestly. The framework's credibility is its moat.
• Avoid legacy PM jargon. Don't smuggle Scrum/Agile ceremonies back in (sprints, story points, standups) unless you're explicitly contrasting them.
• Show, don't assert. Prefer tables, diagrams, code blocks, and worked examples over adjectives.
• Keep filenames ASCII. Use plain hyphens (-), never smart/Unicode hyphens, or sidebar links will break.
• Link generously across pages to keep the playbook navigable.

---

Page status legend

Use these badges at the top of any page you touch:

• Status: Complete — authored and reviewed
• Status: Core draft complete — solid, open to expansion
• Status: Placeholder — scaffold only · [Contributions Welcome ✍️]