Add a PR template matching the repo's What/Why/How/Verified convention#87
Merged
Conversation
PRs already follow this structure by hand; codifying it as a template keeps new PRs consistent and surfaces the squash-title and format/lint/test gate up front.
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.
What
Adds
.github/pull_request_template.mdso every new PR opens pre-filled with the What / Why / How / Verified structure the repo already uses by hand.Why
Recent merged PRs (#85, #84) all follow the same body shape, but nothing enforced it — each was written from scratch. A template makes that convention the default, and surfaces two project-specific reminders at PR-open time: that PRs squash-merge (so the title should be a good squash subject focused on the "why"), and that the
mise run format / lint / testgate must pass.How
The template mirrors the observed convention:
Closes #under Why (matching Add configurable Next/Previous Pane keybindings #84, whichrelease-drafteruses to build the changelog).format / lint / test, running viamise run run, and adding tests for the unit-tested layers (model / persistence / palette / hotkey).No Claude Code footer baked in — the repo's commit convention forbids AI sign-offs, so a per-PR footer would be noise.
Verified
mise run format / lint / test— N/A, no Swift code changed (Markdown-only).