Golem-Agents-Legion gal-rust.instructions.md

Rust Conventions

GAL's own development standard for the crates/ Rust workspace — not a rule injected into downstream repos as house style.

Baseline

Official tooling is authoritative:

• Must pass cargo fmt and cargo clippy.
• Naming follows the Rust API Guidelines — Naming (C-CASE, built on RFC 430): casing, acronyms (Uuid not UUID), and trait/constructor conventions.

Precedence — common standard first, house style second. The Rust API Guidelines above win on any conflict. GAL's house style in naming.md (word choice, word order, the UpperCamelCase headword form) applies only where the standard leaves a free choice and never overrides it.

GAL Deltas

Real deviations from — or additions to — the official baseline, kept because they solve a problem the baseline doesn't cover:

• Error handling: Result<T, E> with thiserror for libraries, anyhow for applications. Never unwrap() in production.

• Monetary values: rust_decimal::Decimal, never f32/f64 — floating point cannot represent currency exactly.

  use rust_decimal::Decimal;
  
  pub struct PriceItem {
      pub name: String,
      pub amount: Decimal,
  }
  

• Comments and docs: always English (CJK allowed only in string literals for testing).

• Test placement: unit tests in mod tests at the bottom of the source file; integration tests in the crate's tests/ directory.