docs: add squash commit guidance to PR template#9
Open
JSRRosenbaum wants to merge 1 commit into
Open
Conversation
mrdanielcasper
requested changes
May 26, 2026
Owner
mrdanielcasper
left a comment
There was a problem hiding this comment.
This is an improvement, but let's remove the quality gates run section and make the manual verification component a description of what steps were taken for local e2e / user validation. I'm finding, especially with LLMs, that I need to pull the levers (until we get a better eval strategy)
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.
Description
Adds a real PR template at
.github/pull_request_template.mdand includes a suggested squash-commit section so reviewers have the merge commit message in the PR body before approval.Why this exists:
.github/workflows/, where GitHub does not use it as the repository PR template.Suggested squash commit
Type of Change
Testing & Verification
Manual verification run:
test -f .github/pull_request_template.mdtest ! -f .github/workflows/pull_request_template.mdgrep -q "Suggested squash commit" .github/pull_request_template.mdgrep -q "Known Follow-up / Out of Scope" .github/pull_request_template.mdQuality gates run:
bash -n setup.sh ctxChecklist
Known Follow-up / Out of Scope