From f7e5822382669e5ab777ca2f87b4eca44d1f6455 Mon Sep 17 00:00:00 2001 From: Janki Luitel Date: Sun, 9 Aug 2026 02:23:32 +1000 Subject: [PATCH 1/4] docs: add usage example peer review template --- .../Products/SplashKit/06-peer-review.mdx | 82 +++++++++++++++++-- 1 file changed, 76 insertions(+), 6 deletions(-) diff --git a/src/content/docs/Products/SplashKit/06-peer-review.mdx b/src/content/docs/Products/SplashKit/06-peer-review.mdx index e6f17e38..0e48689e 100644 --- a/src/content/docs/Products/SplashKit/06-peer-review.mdx +++ b/src/content/docs/Products/SplashKit/06-peer-review.mdx @@ -201,7 +201,7 @@ these steps when reviewing a PR in the SplashKit Starlight repository. - + ```md ## General Information @@ -214,9 +214,8 @@ these steps when reviewing a PR in the SplashKit Starlight repository. ## Code Quality - - [ ] Repository: Is this Pull Request is made to the correct repository? (Thoth-Tech NOT - SplashKit) - - [ ] Readability: Is the code easy to read and follow? If not are there comments to help + - [ ] Repository: Is this Pull Request made to the correct repository? (Thoth-Tech NOT SplashKit) + - [ ] Readability: Is the code easy to read and follow? If not, are there comments to help understand the code? - [ ] Maintainability: Can this code be easily maintained or extended in the future? @@ -241,9 +240,80 @@ these steps when reviewing a PR in the SplashKit Starlight repository. - [ ] Checklist Completion: Have all relevant checklist items been reviewed and completed? ``` - + + + + + ```md + ## Usage Example Review Checklist + + Use this checklist when reviewing SplashKit usage example Pull Requests to help maintain + consistency, quality, and clarity across contributions. + + ### Required Files + + - [ ] C++ implementation included (`.cpp`) + - [ ] Python implementation included (`.py`) + - [ ] C# OOP implementation included (`-oop.cs`) + - [ ] C# Top-Level implementation included (`-top-level.cs`) + - [ ] GIF demonstration included (`.gif`) + - [ ] Text description included (`.txt`) + + ### API Focus + + - [ ] The example clearly demonstrates the intended SplashKit API/function. + - [ ] The example focuses primarily on one SplashKit API/function. + - [ ] SplashKit functions are used instead of language-specific alternatives where possible. + - [ ] Additional functionality does not distract from the API being demonstrated. + - [ ] The example is simple and understandable for new SplashKit users. + + ### Cross-Language Consistency + + - [ ] C++, Python, C# OOP, and C# Top-Level demonstrate the same core behaviour. + - [ ] Equivalent SplashKit APIs are used consistently across supported languages. + - [ ] Comments, terminology, and functionality are reasonably consistent across implementations. + - [ ] File names follow the existing SplashKit usage example naming convention. + + ### Code Quality + + - [ ] The code is clear, readable, and easy to follow. + - [ ] Variable names are meaningful and consistent. + - [ ] Comments are included where they improve understanding. + - [ ] Unnecessary complexity and unrelated functionality have been avoided. + + ### Testing + + - [ ] The example has been tested and runs successfully. + - [ ] The C++ implementation compiles and runs successfully. + - [ ] The Python implementation runs successfully. + - [ ] The C# implementations use the appropriate SplashKit APIs and syntax. + - [ ] The demonstrated behaviour matches the purpose of the usage example. + + ### GIF and Description + + - [ ] The GIF clearly demonstrates the functionality of the example. + - [ ] The GIF matches the submitted implementation. + - [ ] The `.txt` description clearly and concisely describes the example. + + ### Repository Cleanliness + + - [ ] No compiled executables or build artefacts are included. + - [ ] No `.dSYM` directories are included. + - [ ] No log or temporary files are included. + - [ ] No unrelated files or changes are included in the Pull Request. + + ### Final Review + + - [ ] All required usage example files are present. + - [ ] The example remains focused on the intended SplashKit API. + - [ ] The implementations are consistent across supported languages. + - [ ] Previous review feedback has been addressed, where applicable. + - [ ] The Pull Request is ready for approval. + ``` + + - + #### Splashkit Review Prompts - **Type of Change**: Does this Pull Request correctly identify the type of change (bug fix, new From f1b0b8edeacac360aadb62a3bab2ec30c5128e28 Mon Sep 17 00:00:00 2001 From: Janki Luitel Date: Sun, 9 Aug 2026 02:29:09 +1000 Subject: [PATCH 2/4] chore: keep existing peer review content unchanged --- src/content/docs/Products/SplashKit/06-peer-review.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/content/docs/Products/SplashKit/06-peer-review.mdx b/src/content/docs/Products/SplashKit/06-peer-review.mdx index 0e48689e..03b5d961 100644 --- a/src/content/docs/Products/SplashKit/06-peer-review.mdx +++ b/src/content/docs/Products/SplashKit/06-peer-review.mdx @@ -214,9 +214,10 @@ these steps when reviewing a PR in the SplashKit Starlight repository. ## Code Quality - - [ ] Repository: Is this Pull Request made to the correct repository? (Thoth-Tech NOT SplashKit) - - [ ] Readability: Is the code easy to read and follow? If not, are there comments to help - understand the code? + - [ ] Repository: Is this Pull Request is made to the correct repository? (Thoth-Tech NOT + SplashKit) + - [ ] Readability: Is the code easy to read and follow? If not are there comments to help + understand the code? - [ ] Maintainability: Can this code be easily maintained or extended in the future? ## Functionality From 709273a1ef89c44ebe59aa365c6442d7b0e27877 Mon Sep 17 00:00:00 2001 From: Janki Luitel Date: Sun, 9 Aug 2026 02:33:23 +1000 Subject: [PATCH 3/4] style: format peer review documentation --- src/content/docs/Products/SplashKit/06-peer-review.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/Products/SplashKit/06-peer-review.mdx b/src/content/docs/Products/SplashKit/06-peer-review.mdx index 03b5d961..4ea59957 100644 --- a/src/content/docs/Products/SplashKit/06-peer-review.mdx +++ b/src/content/docs/Products/SplashKit/06-peer-review.mdx @@ -215,9 +215,9 @@ these steps when reviewing a PR in the SplashKit Starlight repository. ## Code Quality - [ ] Repository: Is this Pull Request is made to the correct repository? (Thoth-Tech NOT - SplashKit) + SplashKit) - [ ] Readability: Is the code easy to read and follow? If not are there comments to help - understand the code? + understand the code? - [ ] Maintainability: Can this code be easily maintained or extended in the future? ## Functionality From f34e713f08b428f3720df886d70e3b21c5ccdbc7 Mon Sep 17 00:00:00 2001 From: Janki Luitel Date: Fri, 25 Sep 2026 00:49:44 +1000 Subject: [PATCH 4/4] docs: broaden usage example media asset requirements --- .devcontainer/devcontainer-lock.json | 9 +++++++++ src/content/docs/Products/SplashKit/06-peer-review.mdx | 9 ++++----- 2 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 .devcontainer/devcontainer-lock.json diff --git a/.devcontainer/devcontainer-lock.json b/.devcontainer/devcontainer-lock.json new file mode 100644 index 00000000..9b3c0997 --- /dev/null +++ b/.devcontainer/devcontainer-lock.json @@ -0,0 +1,9 @@ +{ + "features": { + "ghcr.io/devcontainers/features/github-cli:1": { + "version": "1.1.2", + "resolved": "ghcr.io/devcontainers/features/github-cli@sha256:7c409bf6316ffd85f04fd92fba85a744282639e603417dd4796409866bdb6805", + "integrity": "sha256:7c409bf6316ffd85f04fd92fba85a744282639e603417dd4796409866bdb6805" + } + } +} diff --git a/src/content/docs/Products/SplashKit/06-peer-review.mdx b/src/content/docs/Products/SplashKit/06-peer-review.mdx index 4ea59957..9aa22050 100644 --- a/src/content/docs/Products/SplashKit/06-peer-review.mdx +++ b/src/content/docs/Products/SplashKit/06-peer-review.mdx @@ -257,7 +257,7 @@ these steps when reviewing a PR in the SplashKit Starlight repository. - [ ] Python implementation included (`.py`) - [ ] C# OOP implementation included (`-oop.cs`) - [ ] C# Top-Level implementation included (`-top-level.cs`) - - [ ] GIF demonstration included (`.gif`) + - [ ] Relevant media asset included (`.png`, `.gif`, or `.webm` as appropriate) - [ ] Text description included (`.txt`) ### API Focus @@ -290,10 +290,9 @@ these steps when reviewing a PR in the SplashKit Starlight repository. - [ ] The C# implementations use the appropriate SplashKit APIs and syntax. - [ ] The demonstrated behaviour matches the purpose of the usage example. - ### GIF and Description - - - [ ] The GIF clearly demonstrates the functionality of the example. - - [ ] The GIF matches the submitted implementation. + ### Media Asset and Description + - [ ] The media asset (`.png`, `.gif`, or `.webm`) clearly demonstrates the functionality of the example, where applicable. + - [ ] The media asset matches the submitted implementation. - [ ] The `.txt` description clearly and concisely describes the example. ### Repository Cleanliness