coding-guidelines

Provide Rust code style, naming conventions, and best practices guidelines.

51|6|Updated Mar 28, 2019
One-click install
npx skills add https://github.com/Mte90/dotfiles --skill coding-guidelines-mte90
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coding-guidelines
Source: https://github.com/Mte90/dotfiles/tree/main/.config/opencode/skills/coding-guidelines
Command: npx skills add https://github.com/Mte90/dotfiles --skill coding-guidelines-mte90

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides clear, actionable rules and best practices for writing high-quality Rust code, ensuring consistency, maintainability, and performance.

Core Features & Use Cases

  • Code Style Enforcement: Offers guidelines on naming conventions, data types, error handling, and more.
  • Best Practice Guidance: Details idiomatic Rust patterns and deprecated features to avoid.
  • Use Case: When reviewing a new Rust pull request, consult this Skill to ensure adherence to established naming conventions and efficient error handling patterns.

Quick Start

Provide guidance on Rust naming conventions for variables and functions.

Frequently Asked Questions about coding-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the best practices for Rust code style and naming conventions?

Rust code style best practices include following specific naming conventions for variables and functions, using idiomatic patterns, and referencing clippy lints to enforce rules. Guidelines cover data types, error handling, memory management, and concurrency.

How do I enforce Rust coding style guidelines during a code review?

To enforce Rust coding style during a code review, consult established guidelines for naming conventions, error handling, and data types. Reference clippy lints and official documentation to ensure adherence to idiomatic patterns.

What common pitfalls should I avoid when writing idiomatic Rust?

Common Rust pitfalls to avoid include deprecated features and improper error handling. Idiomatic Rust requires following established best practices for memory management, concurrency, and macro usage, guided by clippy lints.

Does this Rust coding guidance cover memory management and concurrency rules?

Yes, this Rust coding guidance enforces specific rules for memory management and concurrency. It provides actionable best practices and references clippy lints to ensure consistency, maintainability, and performance.

How do clippy and rustfmt relate to Rust best practices?

Clippy and rustfmt are tools used to enforce Rust best practices and coding style. Guidelines reference clippy lints to address common pitfalls and idiomatic patterns, while rustfmt handles formatting consistency.