Skip to content

About

A collection of rules that AI coding agents can use to write idiomatic, fast, and safe Rust.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

 
 

Repository files navigation

Rust Skills

rules categories Rust license

325 Rust rules your AI coding agent can use to write better code. Current for Rust 1.99 (2024 edition).

Works with Claude Code, Cursor, Windsurf, Copilot, Codex, Aider, Zed, Amp, Cline, and pretty much any other agent that supports skills.

Why

Out of the box, coding agents write average Rust — they clone to dodge the borrow checker, .unwrap() everything, and reach for Box<dyn Trait> when impl Trait would do. These rules encode what expert Rust actually looks like: idiomatic, fast, and safe. Each rule is small and focused, so the agent pulls in only what's relevant to the code in front of it.

Install

npx add-skill codeandsolder/rust-skills2

That's it. The CLI figures out which agents you have and installs the skill to the right place.

Enforce it in CI

For AI-maintained Rust, the repository also provides a strict nightly Rust gate. Import it as one GitHub Actions job:

jobs:
  strict-rust:
    uses: codeandsolder/rust-skills2/.github/workflows/strict-rust.yml@main

It runs rustfmt --check plus the centrally maintained Clippy policy with warnings fatal, pedantic + nursery enabled, and unsuppressible high-signal rules for unwrap/expect, explicit panic placeholders, unsafe documentation, lock-across-await, unexpected cfgs, and stale lint expectations. Checked-in generated Rust can opt into an exact-file lint boundary via package metadata; the generated file still runs through strict Clippy. See docs/strict-ci.md for the policy and customization points.

Migrating an existing codebase across recent stable releases? See the structured Rust 1.88 → 1.99 migration guide.\n\n## How to use it

After installing, just ask your agent:

/rust-skills review this function
/rust-skills is my error handling idiomatic?
/rust-skills check for memory issues
/rust-skills is this unsafe block sound?

The agent loads the relevant rules and applies them to your code.

See it in action

Ask the agent to review a function like this:

// before
fn first_word(s: &String) -> String {
    s.clone().split_whitespace().next().unwrap().to_string()
}

With these rules loaded, it knows to take &str instead of &String, drop the needless clone() and allocation, and return an Option instead of panicking:

// after — applies own-slice-over-vec, own-borrow-over-clone, anti-unwrap-abuse
fn first_word(s: &str) -> Option<&str> {
    s.split_whitespace().next()
}

What's in here

325 rules split into 26 categories:

Category Rules What it covers
Ownership & Borrowing 16 When to borrow vs clone, Arc/Rc, lifetimes, Cell::update, core::range::Range Copy, Edition 2024 RPIT capture, LazyLock/LazyCell (1.80+)
Error Handling 17 thiserror 2.0 for libs (with no_std), anyhow for apps, core::error::Error, #[diagnostic::do_not_recommend], #[expect] over #[allow]
Memory 22 SmallVec, arenas, avoiding allocations, mem::take, drop order, Arc<str>, EcoString, SlotMap, Box::new_uninit
Unsafe Code 8 SAFETY: comments, Miri, MaybeUninit, 2024-edition unsafe extern blocks, Rust 1.99 C-variadic definitions and raw layout queries, #[unsafe(no_mangle)], strict provenance APIs (ptr.addr(), ptr.map_addr(), &raw const/&raw mut)
API Design 20 Builder pattern (bon), newtypes (nutype), sealed traits, FromIterator, #[diagnostic::do_not_recommend]
Async 21 Tokio patterns, channels, async fn in traits, cancel safety, RuntimeMetrics, JoinSet + CancellationToken
Concurrency 4 rayon, scoped threads, atomic ordering, thread-locals
Optimization 14 LTO, inlining, PGO, SIMD, core::hint::cold_path() (1.95), select_unpredictable (1.88)
Numeric & Arithmetic 5 Overflow handling, as vs TryFrom, float compare, NonZero
Type Safety 17 Newtypes, parse don't validate, Deref, Display/Debug, derive_more, nutype, NonZero<uN>, #[repr(transparent)]
Trait & Generics Design 7 dyn vs generic, associated types, blanket impls, object safety, orphan rule, trait object upcasting (1.86+)
Conversions 3 TryFrom, FromStr, AsMut
Const & Compile-Time 4 const fn, const vs static, const generics, const {} blocks
Serde 8 rename_all, default, flatten, enum tagging, validate-on-deserialize
Pattern Matching 5 let-else, matches!, if-let chains, exhaustive matches
Macros 8 macro_rules! hygiene, fragment specifiers, proc-macros with syn/quote
Closures 6 Fn/FnMut/FnOnce bounds, returning impl Fn, move & disjoint capture, async closures `async
Collections 4 HashMap/BTreeMap/IndexMap, Vec/VecDeque, sets, BinaryHeap
Naming 18 Following Rust API Guidelines, C-FEATURE, C-WORD-ORDER (verb-object)
Testing 21 Proptest, mockall, criterion, loom, snapshot tests, assert_matches! (1.96), cargo-nextest, cargo-llvm-cov, rstest, insta, cargo-fuzz
Docs 16 Doc examples, intra-doc links, README/crate-doc unification, #[doc(cfg)], #[doc(hidden)], #[doc = include_str!], Edition 2024 doctests
Observability 7 tracing over log, spans, structured fields, redacting secrets
Performance 18 Iterators, entry API, faster hashers, I/O buffering, <[T]>::array_windows, extract_if (1.87), Atomic*::update (1.95), branch hint APIs
Project Structure 17 Workspaces, module layout, features, MSRV, [lints] table, [workspace.package], cargo publish --workspace (1.90+)
Linting 18 Clippy config, CI setup, unexpected_cfgs, [lints] table, Edition 2024 lints, Dylint, uplifted lints and compatibility checks (1.86-1.99)
Anti-patterns 20 Common mistakes, Arc<Mutex<T>> overuse, async Drop blocking, block_on in async, Deref overuse, unsafe impl Send/Sync shortcuts

Each rule has:

  • Why it matters
  • A bad code example
  • A good code example
  • Links to related rules and sources

How it works

The design is built for low token cost and easy auditing:

  • SKILL.md is a lightweight index — every rule listed as a one-line summary, grouped by category, with a link to its file. The agent reads this first.
  • rules/ holds one Markdown file per rule (<prefix>-<name>.md). The agent opens only the handful relevant to your code instead of loading all 324 — progressive disclosure keeps context small.
  • Prefixes (own-, err-, unsafe-, async-, …) map directly to categories, so an agent reviewing async code can pull just async-, conc-, and own- rules.

CLAUDE.md and AGENTS.md are symlinks to SKILL.md, so the same content works across agent conventions.

Manual install

If add-skill doesn't work for your setup, here's how to install manually:

Claude Code

Global (applies to all projects):

git clone https://github.com/codeandsolder/rust-skills2.git ~/.claude/skills/rust-skills

Or just for one project:

git clone https://github.com/codeandsolder/rust-skills2.git .claude/skills/rust-skills
OpenCode
git clone https://github.com/codeandsolder/rust-skills2.git .opencode/skills/rust-skills
Cursor
git clone https://github.com/codeandsolder/rust-skills2.git .cursor/skills/rust-skills

Or just grab the skill file:

curl -o .cursorrules https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md
Windsurf
mkdir -p .windsurf/rules
curl -o .windsurf/rules/rust-skills.md https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md
OpenAI Codex
git clone https://github.com/codeandsolder/rust-skills2.git .codex/skills/rust-skills

Or use the AGENTS.md standard:

curl -o AGENTS.md https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md
GitHub Copilot
mkdir -p .github
curl -o .github/copilot-instructions.md https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md
Aider

Add to .aider.conf.yml:

read: path/to/rust-skills/SKILL.md

Or pass it directly:

aider --read path/to/rust-skills/SKILL.md
Zed
curl -o AGENTS.md https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md
Amp
git clone https://github.com/codeandsolder/rust-skills2.git .agents/skills/rust-skills
Cline / Roo Code
mkdir -p .clinerules
curl -o .clinerules/rust-skills.md https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md
Other agents (AGENTS.md)

If your agent supports the AGENTS.md standard:

curl -o AGENTS.md https://raw.githubusercontent.com/codeandsolder/rust-skills2/main/SKILL.md

All rules

See SKILL.md for the full list with links to each rule file.

Sources & attribution

These rules are an independent synthesis of official Rust guidance, well-known books, and patterns drawn from widely-used open-source crates. They are not affiliated with or endorsed by the Rust project or any crate author. The text and code examples are original summaries — no substantial content is copied from the sources below.

Official Rust documentation

Books & guides

Tooling

Real-world codebases studied for idioms

  • ripgrep, tokio, serde, clap, polars, axum, cargo, hyper, bevy, rayon, and dtolnay's crates (thiserror, anyhow, syn)

This project is MIT-licensed. Referenced upstream materials remain under their own licenses — the official Rust documentation and API Guidelines are dual MIT / Apache-2.0.

Contributing

PRs welcome. To add or change a rule:

  1. Create rules/<prefix>-<name>.md using a kebab-case id with an existing category prefix (own-, err-, mem-, …).
  2. Follow the format of existing rules: a > one-line summary, then ## Why It Matters, ## Bad, ## Good, and ## See Also (with links that resolve).
  3. Make sure code examples compile on current stable Rust, or explicitly mark/document examples that are intentionally fragments, compile-fail cases, or require nightly.
  4. Run uv run --no-project python checks/gen_index.py after changing rule summaries so SKILL.md stays in sync.
# prefix-rule-name

> One-line imperative summary.

## Why It Matters

Two to four sentences.

## Bad

```rust
// the anti-pattern
```

## Good

```rust
// the recommended pattern
```

## See Also

- [other-rule](other-rule.md) - why it's related

License

MIT

About

A collection of rules that AI coding agents can use to write idiomatic, fast, and safe Rust.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Contributors

Languages