Reading a Pull Request Description
5 exercises — read a realistic GitHub PR description for a pagination feature and answer comprehension questions about motivation, technical changes, test instructions, and issue references.
PR description anatomy
- Summary → what changed, in one paragraph
- Motivation → the problem being solved, with evidence
- Changes Made → specific technical modifications
- How to Test → reproducible steps with expected results
- Related Issues → "Closes #N" auto-closes; "Related to #N" just links
0 / 5 completed
1 / 5
Pull Request #847 — Add Pagination to User List Endpoint
{ex.passage} What is the primary motivation for this pull request, according to the Motivation section?
The motivation is fixing timeout errors for enterprise customers:
The Motivation section says: "Customer support has received 14 reports in the last 30 days of the /api/v2/users endpoint timing out for enterprise customers. The root cause is that the query fetches and serializes the entire users table on every request."
This is a reactive fix for a known production problem, not a new feature. The numbers ("14 reports", "30 days", "5,000+ user accounts") strengthen the case for prioritizing this work.
PR description reading: Motivation vs. Summary
The Motivation section says: "Customer support has received 14 reports in the last 30 days of the /api/v2/users endpoint timing out for enterprise customers. The root cause is that the query fetches and serializes the entire users table on every request."
This is a reactive fix for a known production problem, not a new feature. The numbers ("14 reports", "30 days", "5,000+ user accounts") strengthen the case for prioritizing this work.
PR description reading: Motivation vs. Summary
- Summary → WHAT changed and a brief WHY (the technical solution)
- Motivation → the deeper WHY — the business/user problem being solved, usually with evidence (support tickets, metrics, incident reports)