From 975d79e44b6482463474ba7bfd6179bdbcb0f7b8 Mon Sep 17 00:00:00 2001 From: hsliu Date: Sat, 6 Jun 2026 22:30:28 +0800 Subject: [PATCH] [Doc] Document precheck-pr skill in PR template and contributing guide Add precheck-pr reference to PULL_REQUEST_TEMPLATE.md BEFORE SUBMITTING section, and add a new "Pre-Check with Claude Code" subsection to the contributing guide. Co-Authored-By: Claude Opus 4.7 Signed-off-by: hsliu --- .github/PULL_REQUEST_TEMPLATE.md | 5 ++++- docs/contributing/README.md | 14 ++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1b4762794..f2890c094 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -18,4 +18,7 @@ PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTT - [ ] (Optional) Release notes update. If your change is user-facing, please update the release notes draft. -**BEFORE SUBMITTING, PLEASE READ ** (anything written below this line will be removed by GitHub Actions) +**BEFORE SUBMITTING:** +- Run `/precheck-pr` in Claude Code for a self-check against project conventions — catches dead code, missing benchmarks, and title format issues. +- Please read +(anything written below this line will be removed by GitHub Actions) diff --git a/docs/contributing/README.md b/docs/contributing/README.md index 8a5bcfff0..5464ff1dd 100644 --- a/docs/contributing/README.md +++ b/docs/contributing/README.md @@ -116,6 +116,20 @@ Only specific types of PRs will be reviewed. The PR title is prefixed appropriat !!! note If the PR spans more than one category, please include all relevant prefixes. +### Pre-Check with Claude Code + +Before submitting a PR, run the `precheck-pr` Claude Code skill for a self-review against project conventions: + +``` +/precheck-pr +``` + +The skill offers two modes: +- **Quick (~3 min):** catches showstoppers — PR title format, missing benchmark claims, rebase status +- **Full (~10 min):** thorough maintainer-grade review — dead code scan, copy-paste detection, import hygiene + +The precheck covers five PR types: Bug Fix, Performance, New Model, Diffusion Model, and General. Each type has a tailored checklist that validates evidence quality (repro steps, A/B benchmarks, registry entries, etc.). See the skill in `.claude/skills/precheck-pr/` for the full checklist. + ### Local Test Please run the L1 and L2 test cases locally first and attach the results before contacting us to add the "ready" label. Please refer to the [test instructions](./ci/test_guide.md) for running the test cases.