Skip to content

docs: add branch-naming rule to prevent issue-tracker auto-link collisions #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasK33 merged 1 commit into from
Aug 25, 2026
+8 −0
Merged

docs: add branch-naming rule to prevent issue-tracker auto-link collisions #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ Gotchas:
`gh pr merge` lacks queue support, use GraphQL `enqueuePullRequest`.
- The single required status check is the aggregate `Required` job in
`ci.yml`; it also runs in the merge queue (`merge_group`).
- **Branch names must not collide with issue-tracker IDs.** When a branch
references a GitHub issue number, write it as `issue-<number>` (e.g.
`issue-1234-retry-timeout`), not as a bare `<word>-<number>` (`docs-1234`,
`api-1234`) or a leading number. Connected trackers (e.g. Linear) auto-link
any branch containing a `<key>-<number>` token to the same-numbered issue on
the team that owns `<key>`, which silently attaches the PR to an unrelated
ticket and moves it through that ticket's workflow. The `issue-` prefix keeps
the reference readable and avoids the match.

## Review protocol

Expand Down