PR

Write the title and body Vim-style — area: summary, then Problem: / Solution: — extended with Security Impact: and Testing:.

Two words carry this skill. Mechanism: the Problem section names the exact thing that misbehaves, not the symptom. Receipts: the Testing section pastes output that was really produced, never output that would plausibly have been produced.

Steps

1. Read the diff (git diff <base>...HEAD) in full. The body describes the change that exists, not the change that was planned.
2. If the diff spans unrelated areas, split the PR. Two problems means two PRs.
3. Draft the title from the area of the largest coherent change.
4. Write Problem from the failure, Solution from the idea.
5. Run every command you are about to cite in Testing. Copy its real output.
6. Open the PR with a heredoc, so the markdown survives the shell: