docs: add usage example peer review template - #182
Open
jankiluitel wants to merge 3 commits into
Open
Conversation
✅ Deploy Preview for thoth-tech ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Osaid2993
approved these changes
Aug 11, 2026
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.
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
2 participants
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
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
