Skip to content

Latest commit

 

History

History
8 lines (5 loc) · 725 Bytes

AGENTS.md

File metadata and controls

8 lines (5 loc) · 725 Bytes

Comments in code

Prefer clear names and structure over comments. Add comments only to explain non-obvious constraints, invariants, or behavior that the code cannot express clearly. Keep broader design rationale and implementation history in SCE context. Never use code comments to narrate changes, describe previous implementations, or maintain change logs.

Rust conventions

  • Prefer static dispatch through concrete types, generics, and enums. Use dynamic dispatch (dyn Trait) only when a concrete requirement justifies it.
  • Prefer explicit, typed errors with meaningful variants over anyhow::Error. Preserve underlying causes where relevant. Use anyhow only when typed errors provide no meaningful benefit.