Skip to content

Style Guide

Project style

  • Prefer explicit behavior over compact cleverness.
  • Log state transitions clearly.
  • Avoid hiding system mutations behind vague helper names.
  • Keep generated artifacts inspectable.

Documentation style

  • State design intent.
  • State tradeoffs.
  • State what is inferred vs guaranteed.
  • Avoid pretending rough edges do not exist.