1.5 KiB
Style Guide
The conventions every repo follows, in one place. Brand-neutral on purpose: the
same guide governs hanzoai, zooai and luxfi, because one set of
conventions across the estate is the point.
- Commits — the message, and what a branch is for
- Naming — first principles, no compound words, one name per concept
- Comments and documentation — what code does, not how it got here
- Architecture — one way, addresses, what you do not build
- TypeScript and the web —
@hanzo/gui, tokens, packages - Go — the driver, the ORM, typed ops, identity
- Whitespace — indent width by language, and who decides it
llms.txt is the same index for machine readers, with absolute URLs.
The short version
One and only one way to do everything. Composable, orthogonal, complete. Name it what it is. Write as little code as the job needs, and delete what the job no longer needs. No backwards compatibility, no shims, no second implementation kept alive to avoid moving callers.
Comments say what the code does. The log holds the history.
Never build auth. Never put a secret in source. Never fake a control.
Licence
MIT OR Apache-2.0, per HIP-0137.
Contributing
Open a PR against main. A convention earns its place by removing a decision
someone would otherwise make twice.