Repository navigation
docs: attach PR screenshots with GitHub CLI - #1747
Merged
Merged
Conversation
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 follow-up; no intake issue.
Problem / pressure
The screenshot recommendation in #1744 does not show how to upload images, and its wording mentions committing captures. Agents need a concrete way to share before/after screenshots without adding review-only image files to Git history.
Summary
Point authors to GitHub CLI's native
gh pr create --attachandgh pr edit --attachsupport. Keep PR-only screenshots in temporary or ignored paths, out of commits. The visual guide includes a copyable command that uploads a before/after pair and rewrites local image references in the complete PR body to GitHub attachment URLs.Preserve screenshot optionality, privacy inspection, existing template headings and the absence of an automated screenshot gate. Update the owning bilingual process note.
Visual explanation
Simple change: documentation clarifies the existing screenshot workflow; the command example is the useful review artifact.
Before / after
--attachcommand and local Markdown-reference rewriting guidanceTest plan
node --test .github/scripts/check-pr-template.test.mjs .github/scripts/pr-policy.test.mjs: 23 tests passed.gh pr create --helpandgh pr edit --help: verified native attachment flags, body-file behavior and reference rewriting.pnpm format: passed.pnpm run docs status: reviewed.pnpm run docs check: six existing missing Kimi/Pi submodule links; no new errors or protected-topic changes.Context handoff
Internal same-repository branch. The owning bilingual process note records the attachment clarification alongside the existing optional screenshot recommendation.