Repository navigation
docs: add usage example peer review template - #182
jankiluitel wants to merge 4 commits into
Conversation
✅ Deploy Preview for thoth-tech ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Osaid2993
left a comment
Osaid2993
left a comment
There was a problem hiding this comment.
The Usage Examples review checklist is well structured and should help make reviews more consistent across the team. Nice addition.
Rhinoatron
left a comment
Rhinoatron
left a comment
There was a problem hiding this comment.
Thanks for adding this. The checklist is indeed clear, useful, and covers the main things reviewers should be checking for usage example PRs, including required files, API focus, cross-language consistency, testing, output evidence, and repository cleanliness. I understand the placement in the peer review documentation is intentional, and that makes sense given this is a reviewer checklist. One small note: the checklist refers specifically to a GIF, but the current usage example template also allows an image or other relevant demo file. This does not block approval from me, but it may be worth broadening that wording. Approved.
|
easy to follow and understand good job. |
ralphweng2023
left a comment
ralphweng2023
left a comment
There was a problem hiding this comment.
Good addition to the peer review page, especially the Repository Cleanliness section covering .dSYM directories and build artefacts. One change is needed on the asset wording. The checklist asks for a GIF (.gif) under Required Files and again under GIF and Description, while the Usage Examples overview page lists .png for a simple screenshot, .gif only for recordings and .webm for audio. Followed literally, the checklist would fail a correct screenshot PR.
Rhinoatron raised the same point on 23 Aug and the last commit is still from 8 Aug. Please reword those items to accept .png, .gif or .webm. This was checked against the overview page and the diff only, the site was not built here. A re-review from my side is quick once that is updated.
Planner card: unable to identify the ticket for this PR.
✅ Deploy Preview for thoth-tech ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Thanks for the review. I’ve addressed the asset-format issue by updating the Usage Example Review Checklist to accept .png, .gif, or .webm as appropriate. I’ve also changed the “GIF and Description” section to “Media Asset and Description” so valid screenshot-based usage examples are not incorrectly flagged. I’ve pushed the changes and verified the update. It’s ready for re-review. Thanks! |
ralphweng2023
left a comment
ralphweng2023
left a comment
There was a problem hiding this comment.
Thanks for the quick turnaround on the assets: Required Files now accepts .png, .gif or .webm, and the renamed Media Asset and Description section covers a screenshot-based example. However, the same commit turned the build check red and added a file that does not belong. The check fails at the Prettier step on the new media asset bullet, which needs a blank line after the section heading and to wrap at 100 characters, and npm run format fixes both. .devcontainer/devcontainer-lock.json is also new in this commit and unrelated to the peer review page, so please remove it.
This was checked against the diff and the CI log, the site was not built here. I will re-review as soon as the check is green and the lock file is gone.
Planner card: unable to identify the ticket for this PR.
5 participants
Summary
This PR adds a new Usage Examples tab to the SplashKit Peer Review documentation.
The new checklist is designed to make usage-example reviews more consistent and efficient by giving reviewers a standard set of checks to follow.
What was added
Required file checks for C++, Python, C# OOP, C# Top-Level, GIF and .txt
API focus and SplashKit function checks
Cross-language consistency checks
Code quality and testing checks
GIF and description checks
Repository cleanliness checks
Final approval readiness checklist
Motivation
This was created after identifying that usage-example reviews could benefit from a more consistent review process. The checklist was initially shared with the SplashKit team and, following leadership feedback, was expanded into the project documentation so it can be reused by current and future contributors.
Testing
Tested locally using the Astro development server
Confirmed the Peer Review page renders successfully
Confirmed the new Usage Examples tab displays correctly
Ran formatting/build checks before committing
Evidence
