precheck-pr

Reviews branch diffs against vllm-omni contribution checklists before opening a pull request.

6.5k|1.6k|Updated Sep 11, 2025
One-click install
npx skills add https://github.com/vllm-project/vllm-omni --skill precheck-pr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: precheck-pr
Source: https://github.com/vllm-project/vllm-omni/tree/main/.claude/skills/precheck-pr
Command: npx skills add https://github.com/vllm-project/vllm-omni --skill precheck-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Contributors to vllm-omni often open PRs that fail review for preventable reasons: missing title prefixes, new model-specific examples, dead code, unverified accuracy or benchmark claims, and code-quality regressions. This Skill runs a maintainer-grade self-review of your branch locally so you catch blocking issues before opening the PR.

Core Features & Use Cases

  • Diff-scoped code-quality sweep: Detects five fragility patterns introduced by your diff only — kwargs string-lookup plumbing, broad exception swallows, Any/wrong type hints, hot-path .clone()/deepcopy, and event-loop blocking — without flagging the pre-existing backlog.
  • PR-type checklists in quick or full mode: Categorizes the change as new model, diffusion model, bug fix, performance, or general, then applies the matching checklist covering registry entries, accuracy tests, benchmark rigor, and PR title format.
  • Policy enforcement: Blocks new model-specific Python examples, runs a simplification pass for redundant abstractions, and confirms local pre-commit gates (SPDX headers, forbidden imports, mypy, shellcheck, markdownlint).
  • Use Case: Before pushing a branch that adds a new TTS model, run the full precheck to verify registry entries match __init__.py exports, the PR title uses [Model] <Name> format, and no new broad except clauses were introduced.

Quick Start

Ask the assistant to run the precheck skill in full mode on my current branch before I open a PR against vllm-omni.

Frequently Asked Questions about precheck-pr

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

FAQPage Schema
How do I check my branch before opening a PR to vllm-omni?

Run the precheck skill on your branch, choosing quick mode for a final sanity check or full mode for a maintainer-grade review. It diffs against the merge base with main, validates the PR title prefix, and walks the checklist matching your PR type.

What PR title format does vllm-omni require?

Titles must start with a valid prefix such as [Bugfix], [Model], [Core], [Kernel], [Frontend], [Doc], [CI/Build], or [Hardware][Vendor]. Model PRs must also include the model name, and WIP or Draft markers in the title are blocking failures.

Does the precheck scan the whole repository for code-quality issues?

No, all five code-quality checks are diff-scoped and only count lines your PR adds. The existing backlog of kwargs plumbing, broad excepts, and Any annotations across the repo is explicitly out of scope.

Can I add a new model-specific Python example under examples/?

No, new model-, checkpoint-, vendor-, or family-specific Python examples are blocking violations. Route inference through shared task entrypoints, model behavior through vllm_omni/model_extras, and runnable commands through task docs or recipes/.

Does the precheck skill post comments or open PRs on GitHub?

No, the skill never posts to GitHub, opens PRs, or modifies files. It only prints a severity-marked report to the contributor's terminal listing blocking items, warnings, and passes.