screenshots-in-prs ยท diff
git:20260902.d6f0931 to git:20260903.a48472a
1 added, 1 removed. Audit A to A.
What this update changes in the checks
No check changed: every fixed check gives the same answer before and after this update.
A tripped check is a label, not a verdict: read the matched text and the lines below. This week's updates that newly trip a check.
---
name: screenshots-in-prs
- description: Must be used when opening or updating a pull request that changes rendered UI. Covers capturing screenshots, publishing them, and embedding them in the PR description.
+ description: Use when opening or editing a pull request for a change to rendered UI. Produces safe, matched visual evidence for reviewers.
---
# Screenshots in PRs
- If `config/screenshots.yaml` is absent, state in the PR that screenshot publishing is not enabled and continue without screenshots. Do not use another host.
- Capture the states needed to review the change. Include responsive variants when they clarify it.
- For every change to an existing UI's visible presentation, capture matched `Before` and `After` screenshots. Render `Before` from the PR's base revision and `After` from its head with the same viewport, route, demo data, and UI state, then present the pair side by side. Omit `Before` only for wholly new UI or when a still image cannot show the changed behavior, and state why in `## Screenshots`.
- Default to a 1280x800 viewport. Use descriptive kebab-case PNG filenames; the filename becomes the alt text.
- Published URLs are public and permanent. Use demo data and exclude secrets and personal data.
- From the repository root, run `bun standards screenshots publish <files...>`.
- Put the printed Markdown in a `## Screenshots` section with short captions. Use a two-column table when comparing images side by side helps the review.