Skip to content

docs: state that a PR title is a Conventional Commit - #77

Merged
zgeoff merged 1 commit into
mainfrom
docs/pr-title-conventional
Aug 24, 2026
Merged

docs: state that a PR title is a Conventional Commit#77
zgeoff merged 1 commit into
mainfrom
docs/pr-title-conventional

Conversation

@zgeoff

@zgeoff zgeoff commented Aug 24, 2026

Copy link
Copy Markdown
Owner

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.

  • Gives the PR-title rule its own bullet, with a contrasting pair rather than a description of the rule.
  • Leaves the mood bullet intact, minus the clause that was doing someone else's work.
  • Says nothing about scopes: observed practice varies between an issue number, a package name, and none at all, and commitlint requires none.

In zgeoff/vers this cost four agents in a row, and two squash-merged commits reached main with no type prefix.

Testing

  • AGENTS.md regenerated from the partial

Context

Nothing validates a PR title in CI — commitlint runs only on the commit-msg hook, which never sees it. Wording is the only guard until a repo adds that check.

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.
@zgeoff
zgeoff merged commit 3b44f1a into main Aug 24, 2026
1 check passed
@zgeoff
zgeoff deleted the docs/pr-title-conventional branch August 24, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant