mcpField
I
inkblot-branch-naming

inkblot-branch-naming

github.com/inkblot-therapy开发041 次安装10 周前更新
代码仓库

关于 inkblot-branch-naming

inkblot-branch-naming 是为关联 Jira 工单的工作制定 Git 分支命名规范的技能。分支须以完整的小写工单键开头，并附简短 kebab-case 描述；无工单时不限制命名。

主要功能

  1. 01要求完整小写 Jira 键置前
  2. 02使用简短 kebab-case 变更描述
  3. 03避免类型前缀和叠加工单键
  4. 04无工单时不限制分支名称

适用场景

  1. 01为关联 Jira 工单的改动命名分支
  2. 02让分支在 GitHub 列表中易于识别
  3. 03避免使用无效或缩短的 Jira 键
  4. 04自由命名无工单的杂务和热修复分支

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/inkblot-therapy/ai-skills --skill inkblot-branch-naming

安装后在 Claude Code 中输入/inkblot-branch-naming确认已加载。

详细介绍

Inkblot 分支命名

仅当工作有 Jira 工单时才必须遵守此约定。如果没有工单，不要编造前缀，不要索要工单，也不要限制名称。

工单工作（必须遵守）

分支以完整的 Jira 键（小写）开头。不要添加 feat/ / fix/ / feature/ 这类前缀。

<ticket-id>-<short-kebab>
  1. 完整键、小写、一个主要工单（例如 pod2-2291，而不是 2-2291）
  2. kebab 格式，全部小写，3–5 个单词——描述变更，而不是工单标题
  3. 整个名称应足够简短，便于在 GitHub 的分支列表中阅读（约 50 个字符）
示例
  • pod2-2291-video-call-no-show
  • pod1-3452-company-renewal-dates
  • pod1-3459-coaching-duration-options
不要这样做（仅限工单工作）
  • 不要给工单 ID 加前缀（fix/pod2-2291-…、feat/…、feature/…、bf-…）
  • 不要缩短项目键（2-2291-…、1-3452-…）
  • 分支名称中不要使用大写字母（POD2-2291-…）
  • 名称中不要加入姓名首字母（ji-pod1-2178-…）
  • 不要附加目标环境（-qa、-master）
  • 不要堆叠工单 ID（pod2-2276-2277-2282-…）——使用主要工单
  • 不要把完整的 Jira 标题全部塞进 kebab 名称

无工单

没有命名规则。hotfix/7.54.2、sync/…、qa-kuma 或任何其他名称都可以。

原因

  • 工单优先，不加类型前缀： Jira 和 git grep 需要键位于开头。feat/ / fix/ 只会增加长度。
  • 完整键、小写： pod2-2291 仍然是 Jira 键（链接有效）。使用小写可以避免 macOS 与 Linux 的大小写敏感性差异。2-2291 不是 Jira 键，因此 GitHub/Jira 不会关联该分支。
  • 仅在存在工单时遵守规则： 没有工单的杂务、同步和热修复不应被 Agent 阻止或重命名。
  • 简短的 kebab 名称： GitHub 会截断过长的分支名称；工单标题已在 Jira 中。

评论

支持 Markdown