Skip to content

docs(agents): accept console PR media uploaded to a gist - #2976

Merged
freeqaz merged 1 commit into
mainfrom
docs/pr-media-gist
Oct 20, 2026
Merged

freeqaz merged 1 commit into
mainfrom
docs/pr-media-gist

Conversation

@freeqaz

@freeqaz freeqaz commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator

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

  • AGENTS.md "Console Storybook": media may be native attachments or files in a gist, shown in the Verification section; before/after preferred. Still required before merging UI changes, and still never committed.
  • CONTRIBUTING.md: the same wording.

Verification

Prettier clean. Docs only.

Risks

Policy text; a maintainer should merge it.

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.
@freeqaz
freeqaz requested a review from a team as a code owner October 19, 2026 22:08
@clawsweeper

clawsweeper Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

🦞👀
ClawSweeper picked this up.

Pull request received. I will update this pull request when review starts.

ClawSweeper review complete

ClawSweeper finished reviewing this revision. The review result is being finalized.

View the workflow run.

@clawsweeper clawsweeper Bot added clawsweeper:intake:docs Preliminary submission classification; full source review pending. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. and removed clawsweeper:intake:docs Preliminary submission classification; full source review pending. labels Oct 19, 2026
@clawsweeper

clawsweeper Bot commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge.

What this changes

This 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.

  • Before: The policy requires native GitHub attachments despite the linked media.
  • After: Gist-hosted media satisfies the hosting requirement when it remains accessible and shows the final UI.

Review scores

Measure Result What it means
Overall readiness 🐚 platinum hermit (4/6) A focused, consistent policy update supported by a concrete linked workflow problem; no actionable findings remain.
Proof confidence 🌊 off-meta tidepool Not applicable: This documentation-only PR needs no runtime proof; linked screenshots provide context for the hosting-policy change.
Patch quality 🐚 platinum hermit (4/6) No actionable review findings were identified.

Product

Kind: Docs · Worth it: Yes · Fix scope: Complete
User problem: Console contributors can provide reviewable GitHub-hosted media yet remain blocked by the native-attachment requirement.
Reason: The collaborator-authored direction addresses a documented workflow obstacle without weakening the required evidence.

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
Reviewed head: bb26083837d5eabf36d2a0da5e5f11f21a4a01a2

Before merge

None.

Findings

None.

Agent review details

How this fits together

The 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]
Loading

Technical review

Best 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

Security

None.

Evidence

What I checked:

Labels

Label changes:

  • add P3: This is a narrow contribution-policy improvement with no runtime behavior change.
  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Label justifications:

  • P3: This is a narrow contribution-policy improvement with no runtime behavior change.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🌊 off-meta tidepool and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR.

Rating scale

6/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.

Workflow

ClawSweeper edits this one comment on every review. Comment @clawsweeper re-review for a fresh review only. Repair and merge execution lanes are retired.

Reviewed October 19, 2026, 6:21 PM ET / 22:21 UTC.

@freeqaz
freeqaz merged commit c0cb50f into main Oct 20, 2026
66 checks passed
@freeqaz
freeqaz deleted the docs/pr-media-gist branch October 20, 2026 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant