Coding Guidelines

What it does

This skill provides access to RustFS's coding guidelines. It ensures code adheres to specific stylistic and structural conventions, promoting consistency and readability within a Rust project. The skill can be used to review existing code or generate new code that conforms to these guidelines.

When to use it

• Code Review: Assess the adherence of a codebase to established RustFS coding standards.
• New Code Generation: Generate new Rust code snippets that automatically follow the specified guidelines.
• Refactoring Assistance: Identify areas in existing code that deviate from the guidelines and suggest improvements.
• Team Onboarding: Help new developers quickly understand and adopt the project's coding style.

Key capabilities

• Provides RustFS coding standards documentation.
• Code review functionality against established guidelines.
• Automated code generation adhering to the guidelines.
• Refactoring suggestions for non-compliant code.

Example prompts

• "Review this Rust code snippet and identify any deviations from the RustFS coding guidelines."
• "Generate a function that calculates the factorial of a number, following RustFS coding style."
• "Suggest improvements to this main.rs file to align with RustFS's conventions."

Tips & gotchas

The skill is most effective when used within a project already employing Rust and familiar with basic Rust concepts. While it can identify deviations, understanding the why behind the guidelines requires familiarity with Rust programming principles.