docs: add branch-naming rule to prevent issue-tracker auto-link collisions - #107
Merged
ThomasK33 merged 1 commit intoAug 25, 2026
Conversation
nickvigilante
marked this pull request as ready for review
August 25, 2026 15:31
Member
|
@codex review |
Member
|
@codex security review |
|
Codex Review: Didn't find any major issues. Already looking forward to the next diff. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
Security review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
ThomasK33
deleted the
vigilante/docs-725-adopt-issue-number-branch-name-convention-in-agentsmd-to
branch
August 25, 2026 17:35
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.
What
Add a branch-naming rule to
AGENTS.md: when a branch references a GitHub issuenumber, write it as
issue-<number>instead of a bare<word>-<number>(e.g.docs-1234) or a leading number.Why
Connected issue trackers (e.g. Linear) auto-link any branch whose name contains
a
<key>-<number>token to the same-numbered issue on the team that owns<key>. Adocs-<n>-style branch in this repo can silently attach the PR to anunrelated tracker ticket and move it through that ticket's workflow. The
issue-prefix keeps the number readable while avoiding the match. Thisactually happened to a recent ai-sdk PR, which prompted the rule.
Docs / agent-instructions only; no code or CI changes. Formatted with
pnpm format(oxfmt).Linear: DOCS-725