Skip to content

docs: 📝 Ask for images that show the result in pull requests - #229

Merged
ShisatoYano merged 1 commit into
mainfrom
docs/pr-images
Nov 14, 2026
Merged

ShisatoYano merged 1 commit into
mainfrom
docs/pr-images

Conversation

@ShisatoYano

Copy link
Copy Markdown
Owner

Summary

  • Add .github/pull_request_template.md with Summary, How I checked it works, and Images (what to paste for each kind of change)
  • Step 4 of HOWTOCONTRIBUTE.md asks for images or GIFs that show the result: the demo GIF of a new simulation, or before/after last frames for a change under src/components/
  • pr-review asks for missing images in type B and C PRs (not in PRs opened before this change), compares them with the local results, and opens the locally made images when a PR has none

Why

The maintainer can see from the PR page that the code works, without running it or looking for locally made images. The images can come from an older commit, so the review still runs the code and reports a mismatch.

Images

Not needed (docs only).

🤖 Generated with Claude Code

The maintainer had to run each PR or open locally made images to see
whether the code works. A PR template and Step 4 of HOWTOCONTRIBUTE.md
now ask for the demo GIF of a new simulation, or before/after frames
for a change under src/components/. The images can come from an older
commit, so the review still runs the code and compares.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ShisatoYano ShisatoYano added the documentation Improvements or additions to documentation label Nov 14, 2026
@ShisatoYano ShisatoYano self-assigned this Nov 14, 2026
@ShisatoYano
ShisatoYano merged commit 993a568 into main Nov 14, 2026
3 checks passed
@ShisatoYano
ShisatoYano deleted the docs/pr-images branch November 14, 2026 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant