docs: state that a PR title is a Conventional Commit - #77
Merged
Conversation
The shared partial required Conventional Commits for commit messages, and separately noted that a squash merge makes the PR title the commit subject — but that note sat inside the rule about imperative mood, as its rationale. A reader satisfied the mood rule and moved on, so the type prefix on a PR title was left to a two-hop inference nobody made. Give the PR-title rule its own bullet, with a contrasting pair showing what counts. Nothing checks a PR title in CI, so the wording is the only guard.
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
The partial required Conventional Commits for commit messages and, separately, noted that a squash merge makes the PR title the commit subject — but that note sat inside the imperative-mood bullet as its rationale, so the type prefix on a PR title was only ever a two-hop inference.
In zgeoff/vers this cost four agents in a row, and two squash-merged commits reached
mainwith no type prefix.Testing
AGENTS.mdregenerated from the partialContext
Nothing validates a PR title in CI — commitlint runs only on the
commit-msghook, which never sees it. Wording is the only guard until a repo adds that check.