Code standards¶
Coding conventions governing how Lore source is written.
What this folder is¶
Per-language, per-area conventions for error handling, logging, task spawning, testing, comments, and similar concerns. Each page is a Code-Standard doc — imperative rules paired with rationale, code examples, and reference tables.
The standards¶
- Engineering principles. The values every rule in this folder follows from: performance, correctness by construction, simplicity, determinism, fault isolation, and observability.
- Error handling. Discrete
#[ffi_code]types, per-module#[error_set]enums, forwarding between sets, FFI code allocation, and the no-unwraprule. - Logging.
tracingfor server and tool code, Lore macros for library code, and when to use each log level. - Task spawning. The
lore_spawn!macros that keepLORE_CONTEXTpropagating across async and blocking tasks. - Testing. Unit, async, and smoke test patterns, with the test-independence rules that keep them isolated.
- Comments and documentation. Rust doc-comment expectations and when a code comment earns its place.
Suggested starting points¶
- Writing a new Code Standard page? Start at the doc-standards walkthrough.
See docs/README.md for the full docs structure.