Team Handbook
Baseline engineering guidance — conventions for coding, GitHub workflow, onboarding, and
architecture. Currently a solo project, so this is a lightweight starting point; it's
designed to move to a shared team repo (or per-project CONTRIBUTING.md) as the team grows.
Contents
- getting-started.md — clone, install, run, test
- coding-style.md — conventions + tooling (linters/formatters)
- github-workflow.md — branching, PRs, commits, reviews
- architecture.md — documenting system design + decisions (ADRs)
- documenting-ideas.md — AI-assisted idea → markdown flow
- workflow.md — designing features + the task → build → history cycle
Principles
- Keep docs short and living — a stale guide is worse than none. Date and prune them.
- Codify with tooling where possible (formatters, linters, CI) — the doc explains why, the tooling enforces what.
- Make docs discoverable — link them from each repo's README.