inkblot-branch-naming

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Inkblot branch naming

Inkblot分支命名

This convention is only required when the work has a Jira ticket. If there is no ticket, do not invent a prefix, do not ask for a ticket, and do not restrict the name.

本规范仅在工作对应有Jira工单时要求遵守。如果没有工单，请勿添加前缀，不要索要工单，也不要限制分支名称。

Ticket work (required)

有工单的工作（必须遵守）

The branch starts with the full Jira key, lowercase. Do not add

feat/

fix/

feature/

type prefixes.

text

<ticket-id>-<short-kebab>

Full key, lowercase, one primary ticket (e.g.
```
pod2-2291
```
, not
```
2-2291
```
)
kebab is lowercase, 3–5 words — the change, not the ticket title
Keep the whole name short enough to read in GitHub’s branch list (~50 characters)

分支以完整的Jira工单键开头，全小写。不要添加

feat/

fix/

feature/

这类类型前缀。

text

<ticket-id>-<short-kebab>

完整的工单键，全小写，仅使用一个主工单（例如
```
pod2-2291
```
，而非
```
2-2291
```
）
kebab部分为全小写，3-5个单词——描述所做的变更，而非工单标题
整体名称要足够短，以便在GitHub的分支列表中完整显示（约50字符以内）

Examples

示例

```
pod2-2291-video-call-no-show
```
```
pod1-3452-company-renewal-dates
```
```
pod1-3459-coaching-duration-options
```

```
pod2-2291-video-call-no-show
```
```
pod1-3452-company-renewal-dates
```
```
pod1-3459-coaching-duration-options
```

Do not (ticket work only)

禁止操作（仅针对有工单的工作）

Do not prefix the ticket ID (

fix/pod2-2291-…

feat/…

feature/…

bf-…

)

Do not shorten the project key (
```
2-2291-…
```
,
```
1-3452-…
```
)
Do not use uppercase in the branch name (
```
POD2-2291-…
```
)
Do not put initials in the name (
```
ji-pod1-2178-…
```
)
Do not append the target env (
```
-qa
```
,
```
-master
```
)
Do not stack ticket IDs (
```
pod2-2276-2277-2282-…
```
) — use the primary ticket
Do not dump the full Jira title into the kebab

不要给工单ID添加前缀（如
```
fix/pod2-2291-…
```
、
```
feat/…
```
、
```
feature/…
```
、
```
bf-…
```
）
不要缩短项目键（如
```
2-2291-…
```
、
```
1-3452-…
```
）
分支名称中不要使用大写字母（如
```
POD2-2291-…
```
）
不要在名称中加入首字母缩写（如
```
ji-pod1-2178-…
```
）
不要追加目标环境后缀（如
```
-qa
```
、
```
-master
```
）
不要堆叠多个工单ID（如
```
pod2-2276-2277-2282-…
```
）——使用主工单ID即可
不要将完整的Jira工单标题直接作为kebab部分

No ticket

无工单情况

No naming rule.

hotfix/7.54.2

sync/…

qa-kuma

, or any other name are all fine.

无命名规则限制。

hotfix/7.54.2

、

sync/…

、

qa-kuma

或任何其他名称均可。

Why

为什么要这样规定

Ticket-first, no type prefix: Jira and
```
git grep
```
need the key at the start.
```
feat/
```
/
```
fix/
```
only adds length.
Full key, lowercase:
```
pod2-2291
```
is still the Jira key (linking works). Lowercase avoids macOS vs Linux case-sensitivity.
```
2-2291
```
is not a Jira key, so GitHub/Jira will not attach the branch.
Rule only when a ticket exists: Chores, syncs, and hotfixes without a ticket should not be blocked or renamed by the agent.
Short kebab: GitHub truncates long branch names; the ticket title already lives in Jira.

工单优先，无类型前缀：Jira和
```
git grep
```
需要工单键位于开头。
```
feat/
```
/
```
fix/
```
只会增加名称长度。
完整工单键，全小写：
```
pod2-2291
```
仍然是有效的Jira工单键（链接功能正常）。全小写可避免macOS与Linux之间的大小写敏感性问题。
```
2-2291
```
不是有效的Jira工单键，因此GitHub/Jira无法将分支与工单关联。
仅在有工单时执行规则：无工单的杂务、同步操作和热修复不应被Agent阻止或要求重命名。
简短的kebab部分：GitHub会截断过长的分支名称，而工单标题已存在于Jira中。