agentleFS
cosmonic-labscosmonic-labs/skills/rust-development/SKILL.md

rust-development

Skill21 starsChanged 31 days agoApache-2.0View on GitHub

Expert Rust development guidance covering naming conventions, type safety, error handling, documentation, and best practices based on official Rust guidelines. Use this skill when writing new Rust code, reviewing or modifying existing Rust code, designing Rust APIs or libraries, refactoring Rust codebases, or whenever the user mentions Rust, Cargo, clippy, rustfmt, traits, lifetimes, or `.rs` files.

10 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    All code must pass these checks:

    line 21

“Common” is measured: kept by at least 6 in 10 of the 10 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Rust Development

This skill enforces new code or code changes to conform to proper Rust guidelines.

When to Use

Activate this skill when:

  • Writing new Rust code
  • Reviewing or modifying existing Rust code
  • Designing Rust APIs, libraries, or applications
  • Refactoring Rust codebases

Required Gates (Before Submitting Code)

All code must pass these checks:

cargo +nightly fmt              # format
cargo clippy -- -D warnings     # lint with no warnings
cargo test                      # tests pass
cargo doc --no-deps             # docs build

Code that fails clippy or is not properly formatted should not be committed. See project-and-tooling.md for required lints and rustfmt.toml config.

Reference Files

Load the relevant file when working on the matching topic:

TopicFile
Naming conventions (RFC 430), case rules, conversion methods (as_/to_/into_), getter/iterator method conventionsnaming.md
Type safety (newtypes, primitive obsession, bitflags, builders) and trait implementations (Clone, Debug, From/TryFrom, Deref rules, object safety, Serde behind feature flags)types.md
Error type requirements, thiserror for libraries, anyhow for applications, propagating with ?, let ... else for early returnserror-handling.md
Public-item docs, # Arguments/# Errors/# Panics/# Safety/# Examples sections, #[doc(hidden)] for implementation detailsdocumentation.md
Minimizing unsafe, thread safety, Drop must not fail, avoiding allocations, iterators over indexing, &str over String, Cowsafety-and-performance.md
API design (no out-parameters, intermediate results, constructors as static methods, generics over concrete types, input validation) and forward compatibility (private fields, sealed traits)api-design.md
Cargo.toml metadata, module organization, feature flags, test organization, property-based testing, required clippy lints, rustfmt.toml, pre-commit checksproject-and-tooling.md

Guidelines Sources

These guidelines are based on:

Code Review Checklist

Required

  • Code passes cargo clippy -- -D warnings
  • Code is formatted with cargo +nightly fmt
  • Tests pass with cargo test

Naming (naming.md)

  • Follows RFC 430 case conventions
  • Conversions use as_/to_/into_ correctly
  • No get_ prefix on simple getters
  • Iterator methods follow conventions

Types (types.md)

  • Uses newtypes for distinct concepts
  • Avoids bool/Option parameters with unclear meaning
  • Implements appropriate standard traits
  • Error types implement Error + Send + Sync

Safety (safety-and-performance.md)

  • Minimizes unsafe code
  • Documents safety invariants
  • Validates inputs at boundaries

Documentation (documentation.md)

  • All public items documented
  • Examples compile and demonstrate usage
  • Error/panic conditions documented

Performance (safety-and-performance.md)

  • Avoids unnecessary allocations
  • Uses iterators appropriately
  • Takes references where ownership isn't needed

Testing (project-and-tooling.md)

  • Unit tests for core logic
  • Integration tests for public API
  • Edge cases covered

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.