CONTRIBUTING.md
Contributing
This program is open. Fork it, extend it, remix it. If you find something worth pulling back upstream, open a PR.
What good contributions look like
- New sections — a topic missing at the right level
- Better examples — anchored on real, working systems
- ELI10 companions — new concepts explained plainly
- Corrections — factual, stylistic, or structural
- Translations — the whole program in another language
What contributions won't be merged
- AI-generated filler that reads like a template
- Vendor-specific promotion
- Content that ignores the voice guide (see below)
Voice guide
- Direct. No filler. No AI-tells.
- No emojis in docs.
- No phrases like "let's dive in", "delve", "leverage", "unlock", "in today's fast-paced world".
- Opinionated over neutral. If you don't have a point of view, you probably don't have a contribution.
- Concrete examples over abstractions.
PR checklist
- [ ] Files in the right level and section
- [ ] Every doc has an ELI10 companion if it introduces a new concept
- [ ] Under 800 words unless the topic requires more
- [ ] No emojis, no AI-tells
- [ ] Cross-references to related sections
- [ ] Updated the level's README index if adding a new section
Governance
- Adam Abdalla owns the main branch
- Section owners can be delegated over time
- Major additions go through an issue first for scope check