Rust Best Practices Guide

What problem does it solve?

Help Rust developers write safer, more maintainable, and higher-performing code by codifying conventions across style, error handling, concurrency, and project structure.

Core Features & Use Cases

• Style and formatting: Follow standard formatting with rustfmt and consistent naming conventions to improve readability.
• Error handling and resilience: Promote use of Result, proper propagation, and clear error contexts to prevent panics in production.
• Concurrency and async patterns: Provide guidance on safe concurrency using Arc, Mutex, channels, and async runtimes like Tokio.
• Documentation and testing: Encourage doc comments, doctests, unit tests, integration tests, and CI checks to ensure long-term reliability.

Quick Start

Apply these guidelines to your Rust project to enforce style, error handling, and documentation from start to finish.