docs(pr-template): owner-qualify cross-repo closing keywords#411
Open
LukasWodka wants to merge 1 commit into
Open
docs(pr-template): owner-qualify cross-repo closing keywords#411LukasWodka wants to merge 1 commit into
LukasWodka wants to merge 1 commit into
Conversation
…oc/backend#930) GitHub auto-closes an issue in another repository only when the PR body names it owner-qualified. A bare `repo#N` merely cross-references and closes nothing -- and the template's own hint taught `Ref tracebloc/other-repo#456`, which is not a closing keyword at all. Eight code-complete issues stayed open for days-to-weeks this way (tracebloc/backend#1171-#1176, tracebloc/client#376, #393), dragging two epics to 0% and 14% when the true figures were 67% and 24%. Someone had to notice and close all eight by hand. Also corrects CONTRIBUTING.md, which asserted that a `Closes #N` body line auto-closes on merge. This repo's default branch is `main` while PRs land on `develop`, and GitHub fires closing keywords only on merges into the default branch -- so that claim was wrong in both directions and helped propagate the bug. cli#393 is one of the eight. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
Author
|
bugbot run |
Contributor
Author
|
👋 Heads-up — Code review queue is at 34 / 30 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 4d1f229. Configure here.
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 auto-closes an issue in another repository only when the PR body uses an owner-qualified closing keyword. A bare
repo#N— or a plain#Naimed at another repo — creates a cross-reference and closes nothing. This template's own hint taughtRef tracebloc/other-repo#456, andRefis not a closing keyword at all, so the template was part of the problem rather than the fix.Two lines change in the template: the
Relatedhint now shows the qualified form as the visible example, and one checklist item turns it into a gate.Plus one line in
CONTRIBUTING.md, which was actively teaching the bug. It claimed aCloses #Nbody line means "GitHub auto-closes the issue on merge." That is wrong here in both directions: this repo's default branch ismainwhile PRs land ondevelop, and GitHub fires closing keywords only on merges into the default branch — soCloses #Ndoes not auto-close on merge todevelopat all, cross-repo or not. The corrected bullet covers owner-qualification and that caveat, and stays one bullet. Evidence that this is real and not theoretical: #393 is an issue in this repo that stayed open behind a merged PR.Related
Epic: tracebloc/backend#930 (developer feedback loop)
Evidence
Eight code-complete issues with merged PRs sat open for days-to-weeks:
Two epics consequently under-reported their progress by a wide margin. Someone had to notice and close all eight by hand.
Type of change
Test plan
Markdown-only; no Go code touched, so
make ciis unaffected.One thing worth stating explicitly, since it is the reason the example can be concrete rather than a placeholder: closing keywords inside an HTML comment are inert. This template has carried
<!-- Closes #123 -->since it was written and has never once touched issue #123. So the newFixes tracebloc/<repo>#456example teaches the shape without ever firing.Checklist
go build ./...,go vet, and the Lint job's checks pass locally — n/a, no Go changesFixes tracebloc/<repo>#N— a barerepo#Ncloses nothingNote
Low Risk
Markdown-only contributor guidance; no runtime, security, or build behavior changes.
Overview
Docs-only update to stop contributors from believing cross-repo or
developmerges will auto-close issues.The PR template replaces the misleading
Ref tracebloc/other-repo#456hint with guidance to useFixes tracebloc/<repo>#Nfor cross-repo tickets and to verify closure when PRs merge todevelop(not defaultmain). A new checklist item enforces owner-qualified closing keywords.CONTRIBUTING.mdcorrects the PR-body bullet: it no longer claimsCloses #Nalways auto-closes on merge. It now documents owner-qualification for other repos and that closing keywords only fire on merges to the default branch, sodevelopmerges may require manual issue closure.Reviewed by Cursor Bugbot for commit 4d1f229. Bugbot is set up for automated code reviews on this repo. Configure here.