docs: add a pull request template - #159
Merged
Merged
Conversation
CONTRIBUTING.md's own guidance is one line ("include a summary of
the changes made and why they are necessary"), and there is nothing
in .github/ to back it up. Stratum has a template; this repository
does not, so every PR body has been reconstructed from the maintainer's
own prose habits rather than prompted by anything on screen.
Adapted rather than copied. Stratum's checklist items are specific
to its decompile-and-patch workflow (extract-patches.ps1, the //
Stratum marker convention, no vanilla source committed) and do not
apply here, so this template's checklist is the five local gates
this repository actually has instead: typecheck, lint:ci, format:check,
test:coverage, build:unpack, the same five branch protection already
requires before merge. Added one line neither template has: a
reminder that normal pull requests target dev, not main, since that
rule exists only in AGENTS.md-equivalent private notes and CONTRIBUTING.md
today, not anywhere a contributor opening a PR would see it.
The Testing section asks for real numbers over a bare "tests pass"
checkbox, closer to how Nimbus's unwritten convention already reads
(test counts, coverage percentages, before-and-after numbers for a
performance change) than to Stratum's checkbox-only shape.
Pixnop
approved these changes
Aug 19, 2026
Pixnop
left a comment
Contributor
There was a problem hiding this comment.
Approving. The template asks for exactly what this repo's review culture already demands, evidence over assertion, and the Testing section's 'not just tests pass' line plus the delete-this-line instruction keep it from fossilizing into checkbox theater. One optional refinement for a later pass: the Related issues line hardcodes Fixes, and this repo has twice needed Refs instead for PRs that deliberately address half an issue, so a one-line hint that Refs exists for partial work would save the next contributor the same lesson.
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.
This repository has no
.github/PULL_REQUEST_TEMPLATE.md.CONTRIBUTING.md's own guidance on the subject is one line: "include a summary of the changes made and why they are necessary." Every PR body against this repo has been reconstructed from the maintainer's own prose habits by reading past PRs, not prompted by anything the "Open a pull request" screen shows.Stratum has a template. Its checklist is specific to Stratum's decompile-and-patch workflow (
extract-patches.ps1, the// Stratummarker convention, no vanilla source committed) and none of it applies here, so this isn't a copy. Nimbus has no template file either, but its PRs share a real informal shape worth learning from: dense prose for the summary, and testing evidence given as actual numbers (test counts, coverage percentages, before-and-after numbers for a performance change) rather than a bare "tests pass."What this template does:
typecheck,lint:ci,format:check,test:coverage,build:unpack. These are the same five branch protection already requires ondevandmain, so the checklist is a reminder to run them before pushing, not a new requirement.dev, notmain. That rule currently lives only inCONTRIBUTING.md's prose, nowhere a contributor filling out a PR would see it at the moment it matters.One thing worth knowing before merging: GitHub reads pull request templates from the repository's default branch, which is
mainhere, notdev. Landing this ondev(the normal target for every PR perCONTRIBUTING.md) means it will not show up on the "Open a pull request" screen until the nextdev-to-mainpromotion. Flagging it rather than routing around the branch rule myself.Type
Checklist
dev, notmain.Testing
Not applicable, no code changed. Rendered the file locally to check the checkbox and heading markup displays as intended.
Related issues
None filed. Opened directly off a private-workspace observation while reviewing another PR's absence of guidance.