docs: give a pull request the shape of a review - #2
Open
BryanZaneee wants to merge 1 commit into
Open
Conversation
The checklist items are this repository's own invariants rather than generic hygiene: a box nobody could fail teaches a reviewer nothing. Goldens, the target-specific string ban, the dependency conversation and the honesty contract are each a thing this repo has been wrong about before, so each gets a line. The ADR item carries a not-applicable box on purpose. Most changes do not move an architectural decision, and a requirement that is routinely ignored stops being read at all. Closes #1 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
BryanZaneee
force-pushed
the
docs/1-pr-template
branch
from
August 18, 2026 17:49
7f1dafe to
a6a98e3
Compare
Owner
Author
|
Force-pushed: removed every em dash from the files this PR adds (D0), so they land clean rather than being swept in a follow-up. Rewritten rather than substituted. Content is otherwise unchanged. |
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
1 participant
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
Adds
.github/pull_request_template.md.Why
Everything from here lands through PRs against
develop, so the review surface has to exist before the TypeScript migration starts. Closes #1.Changes
Template with Summary / Why / Changes / Testing, then two checklists. The items are this repo's own invariants — goldens,
generic.test.mjs, the dependency conversation, the honesty contract — rather than generic hygiene.The ADR section carries an explicit not applicable box: most PRs will tick it, and a requirement that is routinely ignored stops being read.
Testing
npm test— no code changed. Template pre-fill can only be verified on the next PR, since GitHub reads it from the default branch.Checklist
test/generic.test.mjsgreen: nothing target-specific insrc/orbin/ADR