rig-review

Validate Rust code changes against Rig project quality gates.

8.2k|927|Updated Jun 5, 2024
One-click install
npx skills add https://github.com/0xPlaygrounds/rig --skill rig-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rig-review
Source: https://github.com/0xPlaygrounds/rig/tree/main/.claude/skills/rig-review
Command: npx skills add https://github.com/0xPlaygrounds/rig --skill rig-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the pre-submission quality checks for Rig code, ensuring adherence to mandatory coding standards, error handling, and compatibility requirements before a Pull Request is opened.

Core Features & Use Cases

  • Automated Code Auditing: Verifies coding style, error handling patterns, WASM compatibility, and documentation standards.
  • Pre-PR Validation: Catches common issues like String error types, unwrap() usage, and missing documentation, preventing wasted review cycles.
  • Use Case: Before submitting a new feature for Rig, run this Skill to confirm your code meets all the project's quality gates, ensuring a smoother review process and higher quality contribution.

Quick Start

Run the rig-review skill to check the current code against Rig's quality gates.

Frequently Asked Questions about rig-review

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

FAQPage Schema
How do I validate Rust code changes for WASM compatibility before a pull request?

Automated code review checks Rust code changes against mandatory quality gates, including WASM compatibility, error handling, and coding style. It analyzes code structure and dependency usage to ensure contributions meet project standards before opening a pull request.

What does the Rig pre-commit code review check for?

The pre-commit code review checks Rust code for adherence to mandatory coding standards, specifically targeting error handling patterns, WASM compatibility, and documentation quality. It catches common issues like improper String error types and unwrap() usage to prevent wasted review cycles.

Do I need to run cargo fmt, cargo clippy, and cargo test for Rust code quality gates?

Yes, you need to run cargo fmt, cargo clippy, and cargo test to confirm code integrity and correctness for Rust quality gates. Executing these commands validates formatting, identifies linting violations, and verifies that the code changes pass all required tests.

Why does my Rust code fail the pre-PR validation due to unwrap() usage?

Your Rust code fails pre-PR validation because unwrap() usage violates mandatory error handling patterns and coding style standards. The automated code auditing process catches these common issues, along with missing documentation and String error types, to ensure robust code quality.

Can I use automated code auditing to check missing documentation in Rust projects?

Yes, you can use automated code auditing to check missing documentation in Rust projects. The validation process analyzes comment quality and verifies documentation standards, ensuring all code changes adhere to the required project quality gates before submission.