Add a PR template and the commit-message pointer - #71
Merged
Conversation
Every family repo squash-merges, so a PR's title and body become the permanent commit message. This repo has among the family's longest commit bodies — a median of 389 words per squash merge, against 28-107 in most family repos — because descriptions were used to show working. Adds .github/PULL_REQUEST_TEMPLATE.md and a "Commit messages" bullet in AGENTS.md pointing at austraits-meta's convention. The template uses prose placeholders rather than HTML comments, which a PR body carries into the commit intact.
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.
Every family repo squash-merges, so a PR's title and body become the
permanent commit message. This repo has among the family's longest
commit bodies — a median of 389 words per squash merge, against 28-107
in most family repos — because descriptions were used to show working.
Adds
.github/PULL_REQUEST_TEMPLATE.mdand a "Commit messages" bulletin
AGENTS.mdpointing at austraits-meta's convention. The templateuses prose placeholders rather than HTML comments, which a PR body
carries into the commit intact.