rust-api-guidelines

Review and refactor public Rust API surfaces against Rust and Microsoft guidelines.

Updated Apr 30, 2026

Search Tags:#code review #refactoring #api #rust #semver #guidelines

Ready to run

npx skills add https://github.com/kazukitcy/skills --skill rust-api-guidelines

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: rust-api-guidelines
Source: https://github.com/kazukitcy/skills/tree/main/rust-api-guidelines
Command: npx skills add https://github.com/kazukitcy/skills --skill rust-api-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the complexity of maintaining high-quality, ergonomic, and semver-stable Rust APIs by integrating industry-standard recommendations from the Rust-lang and Microsoft guideline sets.

Core Features & Use Cases

Comprehensive Review: Evaluates public API surfaces against naming conventions, interoperability standards, and documentation requirements.
Risk Assessment: Identifies breaking changes, semver risks, and potential correctness issues in crate boundaries.
Use Case: Use this skill when preparing a crate for publishing to crates.io or during a PR review to ensure your public types, traits, and macros follow idiomatic Rust patterns and maintain long-term resilience.

Quick Start

Use the rust-api-guidelines skill to perform a full audit of the public API surface in the current crate directory.

Frequently Asked Questions about rust-api-guidelines

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

FAQPage Schema

How do I review a Rust crate for semver stability and API ergonomics?▼

You can audit a Rust crate by applying Rust API Guidelines and Microsoft Rust Guidelines to evaluate public API surfaces, validate documentation, and identify breaking changes or semver risks across crate boundaries.

What are the Rust API Guidelines for designing idiomatic public traits?▼

Idiomatic Rust public traits require validating safety contracts, error design, and interoperability standards against community and Microsoft-specific guidelines to ensure correct and ergonomic API surfaces.

How do I identify breaking changes and semver risks in a Rust library?▼

Identify breaking changes and semver risks in a Rust library by assessing crate boundaries, public type modifications, and trait implementations against established guidelines to detect potential correctness issues.

Can I use this approach to review workspace-internal crates before publishing to crates.io?▼

Yes, you can review workspace-internal crates before publishing to crates.io by auditing public API surfaces, validating documentation, and ensuring idiomatic trait implementations maintain semver stability.

What's the best way to validate error design and safety contracts in a Rust API?▼

Validate error design and safety contracts in a Rust API by evaluating public types and traits against established community and Microsoft-specific standards during a comprehensive API surface review.