Skip to content

STYLEGUIDE.md

Latest commit

 

History

History
54 lines (38 loc) · 906 Bytes

STYLEGUIDE.md

File metadata and controls

54 lines (38 loc) · 906 Bytes

STYLE_GUIDE

License Headers

All source files must include SPDX copyright headers.

# Add/update headers
mise run license:update

# Check headers
mise run license:check

Code Style

  • Rust: format with rustfmt, lint with Clippy.
  • Python: format and lint with ruff, type-check with ty.

Recommended workflow before opening a PR:

mise run fmt
mise run lint
mise run ci

CLI Output Style

When printing structured CLI output:

  • Add a blank line after headings.
  • Indent key-value fields by 2 spaces.
  • Use dimmed labels for field keys (for example, "Id:".dimmed()).
  • Use cyan + bold for primary headings.

Good:

Created sandbox:

  Id: cddeeb6d-a4d3-4158-a4d1-bd931f743700
  Name: sandbox-cddeeb6d
  Namespace: openshell

Bad:

Created sandbox:
  Id: cddeeb6d-a4d3-4158-a4d1-bd931f743700
  Name: sandbox-cddeeb6d
  Namespace: openshell