docs: name gh --attach as the PR media route - #32
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
🟡 Changes recommended
The documented command uses angle-bracket placeholders that are not copy/paste-safe in shells and could mislead contributors.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Updates contributor guidance so UI-change screenshots are shared via GitHub CLI attachments instead of being committed into the repo, aligning PR hygiene with vref’s “don’t commit screenshots” intent.
Changes:
- Clarifies how to provide screenshots when UI output changes.
- Adds a recommended
gh pr comment --attachupload route and instructs not to commit screenshots.
File summaries
| File | Description |
|---|---|
| CONTRIBUTING.md | Documents using gh pr comment --attach to share UI screenshots via PR comments instead of committing them. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 76a454850b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
CONTRIBUTING.mdasks for screenshots or gallery links when UI output changes but names no upload route, so contributors commit the files. The Pull Requests section now namesgh pr comment <n> --attach ./file.pngand says not to commit them.pnpm run verifypassed locally.