From 817e8dc4f4e8c7bb43e581956ee53c216b696455 Mon Sep 17 00:00:00 2001 From: Geoff Whatley Date: Tue, 25 Aug 2026 01:24:32 +1000 Subject: [PATCH] docs: state that a PR title is a Conventional Commit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- AGENTS.md | 4 +++- agents/shared.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index c8c7853..1735495 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -10,8 +10,10 @@ - Perform all work on a branch in a git worktree under `.worktrees/` (e.g. `git worktree add .worktrees/ -b `) — never commit directly on `main`. - Use [Conventional Commits](https://www.conventionalcommits.org/) for all commit messages. +- A squash merge makes the PR title the commit subject, so a PR title is a Conventional Commit too. + `feat(#412): add the retry budget` is a title; `add the retry budget` is not. - Commit subjects and PR titles use the imperative mood ("add X", never "added X" or a bare noun - phrase) — a squash merge makes the PR title the commit subject. + phrase). - Open PRs against `main` using the PR template (`.github/PULL_REQUEST_TEMPLATE.md`). Descriptions are condensed: lead paragraph ≤2 sentences, one-line bullets, ≤150 words — write the short version first, don't draft long and trim. diff --git a/agents/shared.md b/agents/shared.md index 6ac0cd4..9e0b03a 100644 --- a/agents/shared.md +++ b/agents/shared.md @@ -8,8 +8,10 @@ - Perform all work on a branch in a git worktree under `.worktrees/` (e.g. `git worktree add .worktrees/ -b `) — never commit directly on `main`. - Use [Conventional Commits](https://www.conventionalcommits.org/) for all commit messages. +- A squash merge makes the PR title the commit subject, so a PR title is a Conventional Commit too. + `feat(#412): add the retry budget` is a title; `add the retry budget` is not. - Commit subjects and PR titles use the imperative mood ("add X", never "added X" or a bare noun - phrase) — a squash merge makes the PR title the commit subject. + phrase). - Open PRs against `main` using the PR template (`.github/PULL_REQUEST_TEMPLATE.md`). Descriptions are condensed: lead paragraph ≤2 sentences, one-line bullets, ≤150 words — write the short version first, don't draft long and trim.