Skip to content

Evidence Templates

Cindy Zhang edited this page Aug 17, 2026 · 5 revisions

Reviewer evidence templates

Complementary data a reviewer produces so a human can judge fast. Not the review — this is a separate bot-attributed comment, tables only, no prose.

Gap-filler rule: skip anything CI already reports (the PR Analysis Report already posts bundle size, a11y audit, Storybook + sandbox preview links) and anything the PR description already says. Post only what is missing.


Template: LAYOUT / CSS change

A layout change is never proved by one before/after at one width. Parents and grandparents change how an element renders, so the evidence has to name the containment assumptions being relied on.

1. Containment assumptions

State what the fix depends on. Each row is a claim a human can challenge.

Assumption This change relies on Verified
Parent display e.g. flex row yes/no
Which element shrinks e.g. the <button> flex child, not the inner span yes/no
Width source container-defined / children auto-size both tested?
Min-size defaults e.g. flex children default min-width: auto yes/no
Ancestor constraints any overflow, contain, grid track, or fixed height above it yes/no

The #5035 lesson: minWidth: 0 on the inner span does nothing while its parent flex child is unshrinkable. Always say which box is being constrained.

2. Render matrix

One row per case, before and after. Include at least one case where the change is visible, and say plainly when a case is unchanged.

Case Before After What changed
Baseline (short content, wide) identical / …
Long content, container-defined width
Long content, auto-sized container
Component's own layout variants (e.g. hug vs fill)
Narrow viewport (320px)
Mixed: one long child + short siblings
RTL
Text zoom 200%
Forced colors
Icon-only / label-hidden path

Drop rows that genuinely do not apply — say why, do not silently omit.

3. Probe (when the fix is incomplete)

If the change does not achieve its stated goal, add a third column showing the minimal delta that does, and name the one-line diff. That is what turns "this looks wrong" into an actionable review.


Template: API / new surface change

Added Nearest sibling precedent Matches?
propName?: Type Sibling.tsx:123 uses otherName for the same axis yes/no

Plus: prop-overlap count against the base component if it wraps one; whether the new surface is reachable from the components that motivate it (a Calendar prop the date inputs cannot forward is a gap); exports added to the public barrel.

Template: BEHAVIOR / interaction change

Path Covered by the change Covered by a test
pointer click
keyboard (Enter/Space/Escape/arrows)
IME composition
paste
AT / synthetic activation
programmatic call

Interaction fixes cannot be proved in jsdom (no popover light dismiss, no invokers) — say so, and drive real Chromium when it matters.


Always state

  • What was not verified, and why.
  • Which claims are read off source versus observed in a browser.

Clone this wiki locally