rust-quality-gates

Execute Rust project quality gates for format, lint, tests, coverage, schema, and docs.

124|19|Updated Jul 11, 2022
One-click install
npx skills add https://github.com/axone-protocol/contracts --skill rust-quality-gates
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rust-quality-gates
Source: https://github.com/axone-protocol/contracts/tree/main/.agents/skills/rust-quality-gates
Command: npx skills add https://github.com/axone-protocol/contracts --skill rust-quality-gates

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires cargo-make, and includes scripts (resource) components.

What problem does it solve?

Rust quality gates ensure changes to Rust code pass a predefined, comprehensive gate sequence before being merged, reducing risk and drift in the codebase.

Core Features & Use Cases

  • Automates a full gate sequence including formatting, linting, testing, test coverage, schema validation, and documentation checks.
  • Integrates with cargo-make to run the defined tasks locally or in CI as part of the development workflow.
  • Use case: before merging a PR that touches core crates, run these gates to catch formatting, type, or documentation issues early.

Quick Start

Run the gate sequence by invoking the run-all script from the skill directory to execute the predefined tasks.

Frequently Asked Questions about rust-quality-gates

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

FAQPage Schema
How do I run Rust quality gates locally before committing changes?

Run Rust quality gates locally by executing the run-all script from the skill directory to validate formatting, linting, tests, coverage, schema, and docs before committing changes.

What do I need to set up to enforce Rust lint and format checks in my project?

You need the cargo-make dependency and a Bash environment to execute the gate sequence script, which automates Rust lint, format, and test validation tasks locally or in CI pipelines.

Can I use cargo-make to automate Rust test coverage and schema validation in CI?

Yes, cargo-make integrates with this skill to run a predefined gate sequence covering test coverage and schema validation, applicable to both local development and CI pipelines for Rust crates.

What is the best way to catch formatting and documentation issues in Rust crates before merging?

Executing a comprehensive Rust quality gate sequence before merging catches formatting, type, and documentation issues early by validating changes across multiple predefined checks.

Does this Rust quality gate sequence work with standard CI pipelines?

Yes, the quality gate sequence is designed for both local development and CI pipelines, requiring only cargo-make and a Bash environment to execute the validation tasks for Rust crates.

Why should I run Rust quality gates before merging a pull request?

Running Rust quality gates before merging reduces risk and drift in the codebase by ensuring changes pass comprehensive formatting, linting, testing, and documentation checks beforehand.