pr

# Opening Pull Requests Load this skill before opening a pull request in this project. ## Base the title and body on the PR diff, not the latest commit A branch usually contains several commits — initial work, fixups, review responses, rebases. The PR title and body describe the **net change that will land on the base branch**, not the most recent commit. Identify the PR's base branch first. It is usually `main`, but a PR stacked on another feature branch has that feature branch as its base. Then read the full diff against the base: ``` git diff <base>...HEAD git log <base>..HEAD ``` Draft the title and body from what that diff actually contains. ## Title Follows the same Conventional Commits format as a commit message — it becomes the squash-merge commit. See [`docs/dev/COMMITS.md`](../../../docs/dev/COMMITS.md). ## Body Fill in the template at [`.github/pull_request_template.md`](../../../.github/pull_request_template.md). Keep the section headings and the checklist; replace the HTML comment placeholders with real content. Delete checklist items that do not apply rather than leaving them unchecked with no explanation. ## Markdown-doc PRs: link the rendered version When a PR's primary change is adding or substantially modifying a single markdown file (e.g., a design doc or a major docs rewrite), put a link to the rendered version on the branch as the first line under `## Summary`: ``` ## Summary [Rendered](https://github.com/tokio-rs/toasty/blob/<branch-name>/<path-to-file>.md) <rest of summary> ``` Use the PR's head branch name in the URL so the link renders the version under review, not what's on `main`. PR [#787](https://github.com/tokio-rs/toasty/pull/787) is an example. ## Be succinct Reviewers already know Toasty and Rust. Keep the body high-signal: state the problem, the change, and anything a reviewer needs to know to evaluate it. Skip restated context, obvious explanations, and throat-clearing. A reviewer should grasp the important bits in seconds. ## Labels Do not apply labels when creating the PR. Maintainers triage and label PRs separately — see [`docs/dev/labels.md`](../../../docs/dev/labels.md). Passing `--label` to `gh pr create` bypasses that process.