Write the PR Description Reviewers Need
Draft a PR description that states what changed, why, risk, and verification.
A PR description says only “fix invoice export.” Context → change → risk → verification. A thin description shifts discovery work to the reviewer and increases the chance that comments focus on visible details instead of intended behavior. fix invoice export Problem: invoice exports dropped annual-plan discounts. Change: centralizes discount calculation in InvoiceTotals and updates CSV export. Risk: tax-inclusive plans and legacy annual discounts. Verified: unit tests for monthly, annual, and tax-inclusive exports plus manual CSV check for org 4812. Context State the user-visible problem: annual discounts disappear in CSV export. Reviewers now know what behavior the code must repair.…
Sign up free — one personalized lesson every day, matched to your role and goals.
Already have an account? Sign in