[Engineer Name] Style Guide
Overview
[Brief bio and why this engineer's approach matters]
Core Philosophy
[2-3 sentences capturing their fundamental beliefs about software]
Design Principles
When Writing Code
Always
-
[Guideline 1]
-
[Guideline 2]
Never
-
[Anti-pattern 1]
-
[Anti-pattern 2]
Prefer
- [Pattern] over [Alternative] because [Reason]
Code Patterns
See patterns/ for detailed examples.
Additional Resources
-
For detailed philosophy, see philosophy.md
-
For anti-patterns to avoid, see anti-patterns/
-
For canonical examples, see examples/
-
For references (books, talks), see references.md