Skip to content

chore(template): generic cross-repo example in the PR template - #472

Open
LukasWodka wants to merge 1 commit into
developfrom
chore/pr-template-generic-example
Open

chore(template): generic cross-repo example in the PR template#472
LukasWodka wants to merge 1 commit into
developfrom
chore/pr-template-generic-example

Conversation

@LukasWodka

@LukasWodka LukasWodka commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

The pull-request template's cross-repo example named a specific issue in another repository. A placeholder (tracebloc/<repo>#123) says the same thing; the guidance text is unchanged.

Test plan

  • Only the three example strings changed (git diff is 2 lines).
  • No repository-specific issue reference remains in the file.

Note

Low Risk
Documentation-only edits to the PR template with no runtime or security impact.

Overview
Updates the GitHub pull request template so cross-repo closing examples use a generic placeholder instead of a real ticket.

In Related, the cross-repo example changes from Closes tracebloc/backend#2364 to Closes tracebloc/<repo>#123. The checklist line for linking tickets keeps the same Closes tracebloc/<repo>#N wording but drops the trailing (backend#2364) hint. No change to the actual linking rules or check behavior—only example text.

Reviewed by Cursor Bugbot for commit 5978c79. Bugbot is set up for automated code reviews on this repo. Configure here.

The example named a specific issue in another repository; a placeholder says the same thing.
@LukasWodka LukasWodka self-assigned this Sep 11, 2026
@LukasWodka
LukasWodka requested a review from saadqbal September 11, 2026 09:38

@saadqbal saadqbal left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good fix — backend#2364 was a real, if closed, internal ticket sitting in a template that gets copied org-wide. Genericizing the Related-section example to tracebloc/<repo>#123 is clean and matches the placeholder style README already uses.

One nit, non-blocking: the checklist line's trailing (backend#2364) wasn't really an "example" — it's the actual ticket that mandated the closing-ref rule, cited the same way in Makefile:648 and closing-ref-gate.py's docstring. It's still alive in both of those, so nothing traceability-wise is actually lost, but dropping it from the template means a reader of this file no longer sees why the checklist item exists. Worth a second's thought on whether that was intentional, otherwise fine as-is.

@LukasWodka

Copy link
Copy Markdown
Contributor Author

Intentional, yes. This repo is public and the template is copied into every repo in the org, public ones included, so a real internal ticket number in the checklist line surfaces the same way the Related-section example did — it was the same class of leak, just one line down. The provenance you point at (the Makefile line and the gate's docstring) lives in the private tooling repo, which is where a reader who needs the "why" would look anyway; the public template only needs to state the rule.

Happy to add a neutral pointer like "see the closing-ref gate" if you'd rather the checklist item still hint at its origin — say the word and I'll push it. Otherwise this is ready for your approval as-is.

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.

2 participants