rust-code-pr-checklist

Validates Rust and bridge pull requests against Fedi's pre-submit checks and PR template.

78|27|Updated May 4, 2024
One-click install
npx skills add https://github.com/fedixyz/fedi --skill rust-code-pr-checklist-fedixyz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rust-code-pr-checklist
Source: https://github.com/fedixyz/fedi/tree/main/.agents/skills/rust-code-pr-checklist
Command: npx skills add https://github.com/fedixyz/fedi --skill rust-code-pr-checklist-fedixyz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Rust and bridge PRs in the Fedi repo often get opened without running the required local checks or with descriptions that ignore the repository's PR template, causing avoidable review rounds. This Skill gives you a focused pre-submit checklist so your crates/ changes pass CI expectations and your description answers reviewer questions up front. ## Core Features & Use Cases - Pre-submit verification: Confirms just final-check passes, which runs lint, clippy, and tests in one command before you open or update a PR. - PR description guidance: Walks through filling the repo's .github/PULL_REQUEST_TEMPLATE.md sections, including what to put under Description and Testing. - Scope awareness: Applies only to Rust and bridge (crates/) changes, steering UI, docs, and config-only PRs to their own conventions. - Use Case: You just finished a change to crates/federations. Before pushing, use this Skill to run the right checks and draft a proportional PR description that names the tests covering your change. ## Quick Start Ask the assistant to run the Rust PR checklist on your staged crates changes and draft the PR description before opening the pull request.

Frequently Asked Questions about rust-code-pr-checklist

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

FAQPage Schema
How do I check a Rust PR before submitting in the Fedi repo?

Run `just final-check` before opening or updating the PR. It executes lint, clippy, and the test suite in one command, covering formatting, lints, and tests for Rust and bridge changes.

What should a Rust PR description include in Fedi?

Fill the sections in `.github/PULL_REQUEST_TEMPLATE.md`: summarize the change and its rationale, explain design decisions not visible in the diff, flag anything reviewers should scrutinize, and under Testing name the automated tests or manual steps you ran.

Does this checklist apply to UI or documentation PRs?

No. It is scoped to Rust and bridge code under `crates/`. UI (`ui/`), docs, and config-only changes follow their own conventions and should not use this checklist.

How long should a PR description be for a small Rust fix?

Keep it proportional to the change. A small or self-evident fix can be a one-line Description with a `- ref #` reference; do not pad a trivial PR to fill every template section.

What does just final-check run for Rust code?

It runs lint, clippy, and `just test` together, so Rust formatting, lints, and tests are all verified in a single command before submission.