Repository navigation
docs(agents): accept console PR media uploaded to a gist - #2976
Conversation
Console UI PRs need screenshots and a short video in the Verification section. Agents cannot make native GitHub attachments, so allow media uploaded to a GitHub gist as well, and prefer before and after views. Media still never goes into the repository.
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
|
Codex review: needs maintainer review before merge. What this changesThis PR permits Console screenshots and videos hosted in GitHub gists alongside native attachments. Example: The Secret-picker UI PR provides reviewable screenshots and a walkthrough through gist links in Verification.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review Keep this collaborator-authored PR open for maintainer triage; the focused documentation change preserves the visual-evidence gate and introduces no actionable defect. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherThe contribution policy and agent instructions govern how Console contributors provide visual evidence for reviewers before merging. flowchart LR
A[Console contributor] --> B[GitHub attachments or gist]
B --> C[PR Verification section]
C --> D[Reviewer inspects final UI]
D --> E[Visual evidence merge gate]
Technical reviewBest possible solution: Accept reviewable gist-hosted media while retaining screenshots, video, final-state verification, and the existing merge gate. Do we have a high-confidence way to reproduce the issue? The current-main policy explicitly requires native attachments, and the linked review demonstrates that requirement blocking an otherwise accepted UI contribution. Is this the best way to solve the issue? Updating both policy owners is the smallest complete change and retains the substantive review requirements. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against 332455338271. Provenance checked
SecurityNone. EvidenceWhat I checked:
LabelsLabel changes:
Label justifications:
Rating scale6/6 🦀 challenger crab · 5/6 🦞 diamond lobster · 4/6 🐚 platinum hermit · 3/6 🦐 gold shrimp · 2/6 🦪 silver shellfish · 1/6 🧂 unranked krab. Overall follows the weaker of proof and patch quality; ✨ marks media proof (a screenshot, video, or linked artifact) that directly shows the changed behavior. WorkflowClawSweeper edits this one comment on every review. Comment Reviewed October 19, 2026, 6:21 PM ET / 22:21 UTC. |
Problem
AGENTS.md and CONTRIBUTING.md require console PR media as native GitHub attachments. Agents can't create those, so the review bot keeps "needs changes" on UI PRs whose screenshots and walkthrough are already shown in the PR body from a gist (#2922: the bot's only remaining item, verdict on 3110ba7). The owner decided on 2026-10-19 that uploading to GitHub is enough: the media exists so reviewers can preview the change, and before + after is preferred.
Change
Verification
Prettier clean. Docs only.
Risks
Policy text; a maintainer should merge it.