pr-packagelisted

# pr-package **English** | [中文](#中文) Package a working diff into a pull request a maintainer will enjoy reviewing: a factual description that answers *what / why / how-tested / what-could-break*, plus a self-review pass over your own diff. Everything here is generic open-source convention — no house style, no special process to learn. ## When to use - You have committed (or staged) changes and want to open a PR. - You want to self-review before requesting a review from someone else. - You want a consistent PR description format across a repo or team. ## The flow ### 1. Gather the context Know exactly what changed before you describe it. Optionally run the helper: ```bash bash scripts/collect_diff.sh [BASE_REF] # read-only: commits, files, diffstat, secret heuristic ``` It prints the commit list, changed files, a diffstat, any uncommitted leftovers, and a light heuristic scan for accidentally committed secrets. If you skip it, get the same facts by hand: ```bash git log --oneline <base>..HEAD git diff --stat <base>...HEAD git diff --name-status <base>...HEAD ``` ### 2. Draft the description Copy `templates/PR_DESCRIPTION.md` into the PR body and fill every section: - **Summary** — 1–3 sentences: what it does and the outcome. - **Motivation / Context** — why it is needed; link the issue it closes. - **Changes** — the notable changes, grouped by area; call out anything non-obvious. - **How tested** — the actual commands you ran and what you observed (paste output)