rust-guidelines

What problem does it solve?

This Skill addresses the challenge of maintaining consistent, high-quality, and performant Rust code across a project. It provides a comprehensive set of pragmatic conventions to guide developers and AI agents, preventing common pitfalls and ensuring a unified codebase.

Core Features & Use Cases

• Code Quality & Readability: Enforces idiomatic Rust patterns, thorough documentation, clear naming conventions, and static verification tools.
• Performance Optimization: Guides on identifying and optimizing hot paths, leveraging efficient allocators like Mimalloc, and designing for high throughput.
• Safety & Resilience: Establishes strict rules for unsafe code usage, robust error handling with canonical structs, and predictable panic behavior.
• Use Case: A developer or AI agent is reviewing a new Rust module and needs to ensure it adheres to project standards. This skill can be activated to provide immediate guidance on documentation, error handling, performance, and safety, ensuring the code meets all quality gates.

Quick Start

Review the attached Rust code for adherence to the project's pragmatic Rust guidelines, focusing on documentation, error handling, and performance best practices.