Tl;dr
1-liner if the context of the change is long
Context
A few sentences on the high level context for the change. Link to relevant design docs or discussion.
This Change
What this change does in the larger context. Specific details to highlight for review. Include UI change screenshots or videos if applicable:
-
Callout 1
-
Callout 2
-
Callout 3
Test Plan
Go over how you plan to test it. Your test plan should be more thorough the riskier the change is. For major changes, I like to describe how I E2E tested it and will monitor the rollout.
Links
-
link to ticket
-
link to design doc
-
link to design
Checklist
-
Pull request title is succinct with [tiny] if it’s extra small
-
Describes the problem
-
Describes the solution (screenshots included if UI changes)
-
Has a test plan
-
Contains links to any context (Slack, Figma, JIRA ticket, etc.)
-
Code is self reviewed for readability, approach, and edge cases
-
Lines changed that may require additional explanation are annotated with an explanation
-
Change is ideally < 500 lines if possible. < 150 is ideal.