Skip to content

Code Style Guide¶

Documentation In Progress

This page is under development. Check back soon for comprehensive style guidelines.

Overview¶

Ralph Orchestrator follows Rust community conventions with project-specific additions.

Rust Style¶

Follow Rust API Guidelines
Use cargo fmt for formatting
Use cargo clippy for linting

Pre-commit Hooks¶

# Install hooks
./scripts/setup-hooks.sh

# Hooks run automatically on commit:
# - cargo fmt --check
# - cargo clippy

Documentation Style¶

Use present tense ("adds" not "added")
Keep lines under 100 characters
Include examples for public APIs

See Also¶

Development Setup - Environment setup
Testing - Test guidelines
Submitting PRs - PR process