Skip to content

docs: recommend before and after screenshots for UI pull requests - #1744

Merged
Lampese merged 3 commits into
mainfrom
codex/ui-pr-screenshot-guidance
Oct 19, 2026
Merged

Lampese merged 3 commits into
mainfrom
codex/ui-pr-screenshot-guidance

Conversation

@Lampese

@Lampese Lampese commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Related issue

Same-repository documentation change; no intake issue.

Problem / pressure

UI pull requests can describe a visible change without showing how it looks before and after. Reviewers then need to reproduce both versions, while authors lack practical guidance for sharing screenshots without exposing personal workspace data.

Summary

Recommend labeled before/after screenshots in the PR template's existing comparison section. Encourage Agents to capture the baseline and verified result during their implementation loop, using synthetic data and comparable viewport, theme, and UI state.

Add capture and privacy guidance to the visual explanations guide: inspect final images before any upload or commit, share only sanitized exports, and use artifacts reviewers can access. Screenshots are optional and may be omitted without explanation.

The recommendation introduces no screenshot requirement or automated gate. Existing template headings and structural-view validation remain unchanged. The existing Agent authoring rule already routes authors to the template, so this change leaves the nearly full AGENTS.md files alone.

Visual explanation

Simple change: documentation adds an optional screenshot recommendation and practical guidance; there is no UI or runtime behavior change to illustrate.

Before / after

Before After
Comparison section contains a generic text table Authors are encouraged to include labeled before/after screenshots of UI changes
Visual guide explains structural views It also explains comparable real UI captures, synthetic fixtures, privacy inspection, and accessible artifacts
No explicit optional screenshot guidance Authors may omit screenshots without explanation

Test plan

  • node --test .github/scripts/check-pr-template.test.mjs .github/scripts/pr-policy.test.mjs: all 23 tests passed, including complete and rejected PR bodies.
  • pnpm format: passed.
  • pnpm check: passed before the final documentation wording revision, including workspace type checks, lint, tests, and boundary checks. Runtime sources are unchanged; formatting and the 23 PR-template/policy tests were rerun after that revision.
  • pnpm run docs status: reviewed.
  • pnpm run docs check: retains the six existing broken Kimi/Pi submodule links in the bilingual subagent-events note; no new documentation errors or SHA-protected topic changes.
  • No rendering tests or screenshots were added for this documentation-only change.

Context handoff

Internal same-repository branch. The bilingual process note records the distinction between recommended screenshot comparisons and existing mandatory structural views. No private screenshots or captured conversations are included.

@Lampese
Lampese marked this pull request as ready for review October 19, 2026 22:11
@Lampese
Lampese merged commit 285b3c4 into main Oct 19, 2026
17 checks passed
@Lampese
Lampese deleted the codex/ui-pr-screenshot-guidance branch October 19, 2026 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant