Documentation
README
Codebase Design
Seek deep modules: substantial useful behavior behind a small, stable interface. Use the concepts below as design lenses, while matching the repository's established domain language.
Working vocabulary
- Module: a coherent unit with an interface and implementation, at any scale.
- Interface: everything callers must know, including invariants and failure modes—not just a type signature.
- Seam: a location where behavior can vary without editing its callers.
- Adapter: an implementation that connects at a seam.
- Depth: useful capability relative to interface complexity.
- Leverage: capability gained by callers; locality: change and knowledge concentrated for maintainers.
This is the opening of the README. Read the full README on GitHub.