docs: correct the PR issue-linking mechanism - #254
Merged
Conversation
jbadeau
approved these changes
Jul 28, 2026
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
2 participants
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.
CLAUDE.mddocuments branch naming but says nothing about PR titles or issue linking, so theGH-<issue>convention exists only as practice.The merged #253 stated the mechanism backwards — it said the title cross-references the issue. It does not: titles are never scanned, and a bare
#168in a title fails the same way.What does resolve is
GH-<issue>in a commit message — a built-in GitHub reference form needing no autolink configuration. Commit31bc9c2ecarries onlyGH-168andGH-248, no bare#N, and both issues receivedreferencedevents from it. Since this repo is rebase-merge only, the PR body never enters history, which makes the commit subject the one reference that survives the merge — and the reason the title prefix is worth keeping.Also records that GitHub parses closing keywords anywhere in a body, and that keywords in a title never close.
Relates to #253
This pull request was published with assistance from Claude.