Repository navigation
docs: recommend before and after screenshots for UI pull requests - #1744
Merged
Merged
Conversation
Model: gpt-6.1-sol
Model: gpt-6.1-sol
Model: gpt-6.1-sol
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdfiles 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
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.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.