From f852de7336511478fe53f9539e2803e53319b731 Mon Sep 17 00:00:00 2001 From: hsliu Date: Mon, 8 Jun 2026 07:03:28 +0800 Subject: [PATCH] Address review feedback on precheck-pr skill - Fix base-branch detection: use BASE_SHA, fallback to origin/main ref - Add union instruction for multi-category PRs in Step 3 - Enforce [Model] prefix includes model identifier - Scope Cache-DiT check: blocking for top-level pipelines, warning for subclass - Recognize deferred accuracy/perf claims in PR body - Add import hygiene carve-out for closures/factory functions Co-Authored-By: Claude Opus 4.7 Signed-off-by: hsliu --- .claude/skills/precheck-pr/SKILL.md | 11 ++++++++--- .claude/skills/precheck-pr/references/checklists.md | 10 +++++----- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.claude/skills/precheck-pr/SKILL.md b/.claude/skills/precheck-pr/SKILL.md index 229be23cd..ab6034a48 100644 --- a/.claude/skills/precheck-pr/SKILL.md +++ b/.claude/skills/precheck-pr/SKILL.md @@ -21,9 +21,11 @@ Default to quick if unsure. Run full before marking a PR "ready for review." ### Step 1: Detect Base Branch ```bash -BASE=$(git merge-base HEAD origin/main 2>/dev/null || git merge-base HEAD main 2>/dev/null) -BASE=${BASE:-main} -git diff --name-only ${BASE}...HEAD +BASE_SHA=$(git merge-base HEAD origin/main 2>/dev/null \ + || git merge-base HEAD main 2>/dev/null \ + || echo origin/main) +echo "diffing against ${BASE_SHA}" +git diff --name-only ${BASE_SHA}...HEAD ``` ### Step 2: Validate PR Title @@ -43,6 +45,7 @@ Check the most recent commit message (or branch name if no commit yet) against t | `[Misc]` | Other changes (use sparingly) | ✗ if: missing prefix, wrong case (`[bugfix]`), or WIP/Draft in title. +⚠ if: `[Model]` prefix without the model identifier (e.g., `[Model] Add new model` — should be `[Model] Add ...`). ### Step 3: Categorize the PR @@ -54,6 +57,8 @@ Check the most recent commit message (or branch name if no commit yet) against t | Perf/benchmark/throughput claims in commit msg or diff | **Performance** | | Everything else | **General** | +If multiple rows apply (e.g., a diffusion model is also a new model), union the checklists. + ### Step 4: Run Checklist Ask: "Quick mode or full mode?" Then walk the checklist for the detected PR type from [references/checklists.md](references/checklists.md). Each item produces ✓, ✗, or ⚠. diff --git a/.claude/skills/precheck-pr/references/checklists.md b/.claude/skills/precheck-pr/references/checklists.md index 5518d702d..5b9472d96 100644 --- a/.claude/skills/precheck-pr/references/checklists.md +++ b/.claude/skills/precheck-pr/references/checklists.md @@ -31,7 +31,7 @@ PR title must follow the project convention documented in `docs/contributing/REA ✗ [WIP] Add model ← WIP in title ``` -- [ ] **Title has valid prefix** — ✗ if missing prefix, wrong case, or WIP/Draft in title +- [ ] **Title has valid prefix** — ✗ if missing prefix, wrong case, or WIP/Draft in title. For `[Model]` PRs, the title MUST also include the model identifier (e.g., `[Model] Add ...`). ⚠ if missing the model name. --- @@ -98,9 +98,9 @@ PR title must follow the project convention documented in `docs/contributing/REA 4. Dead branch guards — `if version > X` where X is always satisfied 5. Unused parameters — `__init__` args never accessed - [ ] **Copy-paste detection:** no string constant defined in 3+ files, no cross-module validation duplication, no near-identical shape coercion fns -- [ ] **Import hygiene:** no re-export-only imports, no module-level side effects without docs, no `import os` in function body when already at top -- [ ] **Accuracy:** at least one test compares output against reference; audio = valid WAV at correct sample rate; determinism verified if seed claimed -- [ ] **Performance:** hardware, software versions, warmup, and metrics (RTF, VRAM, RPS, latency) stated +- [ ] **Import hygiene:** no re-export-only imports, no module-level side effects without docs, no `import os` in function body when already at top. Function-body imports are acceptable when the import is only reachable from a closure or factory return value (i.e., `import` would otherwise execute at module load even though the user may never trigger that path). Either lift to top-of-file or annotate with `# noqa: PLC0415`. +- [ ] **Accuracy:** at least one test compares output against reference; audio = valid WAV at correct sample rate; determinism verified if seed claimed. ⚠ if missing and not explicitly deferred to a follow-up PR or RFC section; — if explicitly deferred (the deferral target SHOULD be linked in the PR body). +- [ ] **Performance:** hardware, software versions, warmup, and metrics (RTF, VRAM, RPS, latency) stated. ⚠ if missing and not explicitly deferred; — if explicitly deferred. - [ ] **Benchmark settings:** model config (TP, PP, max_model_len, enforce_eager, quant), runtime config (batch, input/output spec), environment versions - [ ] **Benchmark script checked in + exact command line + pytest summary** @@ -112,7 +112,7 @@ Diffusion models live under `vllm_omni/diffusion/`. In addition to the New Model - [ ] **Transformer adapter follows contract:** inherits from `nn.Module`, implements `load_weights()`, uses `vllm_omni.diffusion.attention.layer.Attention` - [ ] **Pipeline has both offline and online paths:** `forward()` for batch generation, streaming path for online serving -- [ ] **Cache-DiT integration:** at least one acceleration (TeaCache, FBCache, etc.) is wired up +- [ ] **Cache-DiT integration:** at least one acceleration (TeaCache, FBCache, etc.) is wired up. ✗ for new **top-level** pipelines. For **subclass** pipelines that inherit `__call__` from a parent where Cache-DiT is already absent, downgrade to ⚠ and recommend filing a follow-up issue against the parent pipeline family. - [ ] **Parallelism config:** TP/SP/USP/CFG-Parallel options exposed in pipeline config - [ ] **Docs table updated:** model added to `docs/models/supported_models.md` with correct metadata - [ ] **E2E test exists:** at least one test exercises the full generate path