Repository navigation
docs: 📝 Ask for images that show the result in pull requests - #229
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.github/pull_request_template.mdwith Summary, How I checked it works, and Images (what to paste for each kind of change)HOWTOCONTRIBUTE.mdasks for images or GIFs that show the result: the demo GIF of a new simulation, or before/after last frames for a change undersrc/components/pr-reviewasks 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 noneWhy
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