docs: closing keyword goes in the PR description, once per issue - #283
Open
0xKT wants to merge 3 commits into
Open
docs: closing keyword goes in the PR description, once per issue#2830xKT wants to merge 3 commits into
0xKT wants to merge 3 commits into
Conversation
GitHub pairs a closing keyword with a single reference, so a comma list of issue numbers after one keyword closes only the first. Both places that document this section showed a single issue, and the template's hint was itself shaped like a comma list, which is how a recent PR left seven issues open after merge. Three changes: the template names the rule where the body actually gets written, the filling rules in AGENTS.md state it, and the preview-verification list gains the gh query that reports what GitHub parsed. The error is invisible in the rendered body and visible in that output before merge. The template's placeholder also stops being a real number. The one it named is a live issue in this repo, and whether the keyword parser skips an HTML comment is not something this branch established, so leaving the comment in a description should not be able to close anything. Co-authored-by: Claude (claude-opus-5[1m]) <noreply@anthropic.com>
The rule is one line: repeat the keyword for every issue. The first draft wrapped it in an explanation of how GitHub parses references, and added a `gh pr view --json closingIssuesReferences` step to every PR opening. Once the rule is stated where the description gets written, that check returns the expected number every time, so it is a standing cost for a closed hole. Keeps the template hint and the AGENTS.md filling rule, both one line. Restores the preview-verification list to its four original steps. Co-authored-by: Claude (claude-opus-5[1m]) <noreply@anthropic.com>
Section 3.1 listed `Closes #123` as a commit footer that auto-closes the issue on merge. Section 3.3 already records that this repo squash-merges and drops individual commit bodies, so such a footer never reaches main and closes nothing. Sections 3.3 and 3.7 both place the closing keyword in the PR description; this removes the one line that contradicted them. Co-authored-by: Claude (claude-opus-5[1m]) <noreply@anthropic.com>
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.
Summary
GitHub pairs one closing keyword with one reference.
Fixes #NNN, #MMMclosesthe first and merely mentions the second. PR #279 wrote seven issues after a
single keyword and left six of them open after merge; they were closed by hand.
Two one-line changes state the rule where a description actually gets written:
.github/pull_request_template.md- theRelated Issueshint.AGENTS.md, section 3.7 - theRelated Issuesfilling rule.A third drops
Closes #123from the commit-footer list in section 3.1. Thatline was wrong on its own terms: section 3.3 already records that this repo
squash-merges and drops individual commit bodies, so a closing keyword in a
commit footer never reaches
mainand closes nothing.The template hint also stops naming
#123, which is a live open issue here, anda placeholder should not be a real number.
Type
Verification
Documentation only; no code paths change.
Risk
No behaviour change. The visible effect is a slightly longer hint under
Related Issueswhen a new PR opens.Rollback is a revert of this branch.
Related Issues
N/A