Appearance
Executive summary
The example team chooses a concise review brief with an explicit ask, evidence, risks, and next step. This keeps GitHub as the discussion and approval record.
Context
Unstructured handoffs can make the requested decision difficult to locate. The team wants a lightweight format that helps reviewers scan without duplicating issue tracking.
Options considered
- Concise structured brief: makes the review request and evidence predictable, with a modest authoring cost.
- Free-form notes: allows flexibility, but can hide the requested action.
Decision
Use the concise structured brief for review items that need an explicit decision. Small routine changes can continue to use the source pull request description alone.
Consequences
- Reviewers can look for the same decision and evidence sections.
- Authors must keep the brief aligned with its source pull request.
Evidence and next step
This sanitized sample is illustrative, not empirical evidence. The example team will revisit the format after trying it on a review item.