diff --git a/pull-requests.md b/pull-requests.md index 88440b4..b15efa5 100644 --- a/pull-requests.md +++ b/pull-requests.md @@ -28,14 +28,16 @@ Use a structured format: ```markdown ## Summary -Brief explanation of what this PR does and why. +What changed and why — 1-3 sentences. Explain the motivation, not just the diff. -## Changes -- Bullet list of specific changes +## Validation +How you verified it works — steps taken, commands run, screenshots if UI. -## Test Plan -- How you verified this works -- What to check during review +## Tests +What tests were added, updated, or run. If no automated tests, explain manual testing. + +## Notes +Anything reviewers should know — migration steps, deploy order, follow-ups, breaking changes. Omit this section if empty. ``` The summary should explain **why** the change is needed, not just restate the diff. Reviewers can read the code; they need context.