docs(config): teach PR workflow to attach visual evidence - #1737
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Approved automatically: @FelixTJDietrich is listed in the REVIEW_POLICY_MAINTAINERS repository variable, which the repository treats as satisfying the review requirement. See the review policy in docs/contributor/ci-cd.mdx.
|
Warning Review limit reachedNext included review available in 28 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (4)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
size:M
documentation
e1a483d to
4ead1f4
Compare
There was a problem hiding this comment.
Approved automatically: @FelixTJDietrich is listed in the REVIEW_POLICY_MAINTAINERS repository variable, which the repository treats as satisfying the review requirement. See the review policy in docs/contributor/ci-cd.mdx.
📚 Documentation Preview
|
🧩 Storybook Preview
|
1 participant
What changed and why
Pull requests that change the UI need durable visual evidence, but the contribution workflow did not explain how to publish local images or videos without committing them. This update integrates GitHub CLI's native
--attachsupport into/land-pr, keeps PR-only files in the ignoredtmp/directory, and separates PR creation from upload so the same path works for new and existing pull requests.The root guide now states only the evidence policy and leaves mechanics to
/land-pr. The pull request template is also shorter and asks directly for the problem, verification, release impact, reviewer context, and visual evidence without duplicating commands already enforced elsewhere.How to test
pnpm run format && pnpm run check.pnpm run check:instructionsand confirm both/land-prcopies remain identical.mkdir -p tmp && git check-ignore -v tmp/proof.pngand confirm Git ignores PR-only evidence.gh pr edit --help | grep -q -- --attachand confirm the installed CLI supports the documented upload command.The local quality gate and pre-push quality gate pass. No attachment was uploaded to this documentation-only PR because it has no UI change or meaningful visual evidence.
Release impact
No changeset is needed: this changes contributor documentation and tooling only, not shipped product behavior. Operators do not need to take action.
Notes for reviewers
The key design choice is to create or locate the pull request first, then upload evidence with
gh pr edit. This avoids skipping uploads on an existing PR and prevents an upload failure from being mistaken for a failed PR creation.Authored by OpenAI Codex in Jean.