mcpField
I
inkblot-commit-message

inkblot-commit-message

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

关于 inkblot-commit-message

面向编码 Agent 的提交信息规范，规定关联 Jira 工单时的提交主题格式；无工单时不限制主题。每条相关提交使用一个大写工单键和祈使式摘要。

主要功能

  1. 01主题使用大写 Jira 工单键
  2. 02每次提交对应一个工单
  3. 03祈使式句子大小写摘要
  4. 04不使用 Conventional Commits 前缀
  5. 05不要求提交正文

适用场景

  1. 01为 Jira 跟踪的改动编写提交信息
  2. 02处理关联多个工单的分支提交

安装

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

$npx skills add https://github.com/inkblot-therapy/ai-skills --skill inkblot-commit-message

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

详细介绍

Inkblot 提交消息

仅当工作有 Jira 工单时，才需要遵循此约定。如果没有工单，不要编造 ID，不要索要工单，也不要限制主题内容。

工单工作（必需）

<TICKET-ID>: <Concise imperative summary>
  1. 完整的 Jira 键，大写，每次提交一个工单（例如 POD2-2291，而不是 pod2-2291 或 2-2291）
  2. 键后加冒号和空格，再写祈使句式的摘要（“Fix …”“Add …”“Rename …”）
  3. 使用句首字母大写格式。单行。目标长度约为 72 个字符。说明结果，而不是列出文件。
  4. 在主题中写明本次提交所属的工单，而不是 PR 中的所有工单，也不总是分支名称所对应的工单。

不要使用 Conventional Commits 前缀（feat:、fix:、chore:）。工单就是分类标识。

同一项工作涉及多个工单时

一个分支或 PR 可以列出多个工单。每次提交仍只能有一个键：该提交实现或修复的工单。

  • 如果提交对应分支工单，默认使用分支工单（pod2-2291-… → POD2-2291: …）。
  • 如果本次提交对应其他关联工单，则将主题切换为该工单的键。
  • 如果无法确定本次提交属于哪个工单，请询问。不要编造 ID，也不要堆叠多个键（POD2-2276-2277: …）。

示例——分支 pod2-2276-restrict-provider-access，还关联了 POD2-2277：

  • POD2-2276: Restrict availability reserved-for-client
  • POD2-2277: Hide estimates from unauthorized clients
示例
  • POD2-2291: Fix no-show video call outcome
  • POD2-2291: Baseline the false-positive Brakeman role warning
  • POD1-3452: Rename renewal date service to resolver
  • POD1-3452: Guard missing specialized renewal periods
正文

没有规则。不要求填写正文，除非用户提出要求，否则不要添加正文。上下文在 Jira 中。

不要这样做（仅限工单工作）
  • feat: add renewal dates / fix: …——不要使用 Conventional Commits
  • pod2-2291: Fix no-show …——提交中的键要大写
  • 2-2291: Fix no-show …——这不是 Jira 键
  • POD2-2291 - fix stuff——使用 : ，不要使用 -
  • POD2-2291: Fixed bug——优先使用祈使句（Fix …）
  • POD2-2276-2277: …——主题中只放一个主要工单
  • 编造工单 ID
验证（用于钩子 / lint）
^[A-Z][A-Z0-9]+-[0-9]+: .+

无工单

主题没有规则。合并提交、同步和其他未追踪的工作可以使用任意主题。

原因

  • 主题中包含工单： Jira Smart Commits 和 GitHub–Jira 链接会读取提交主题。仅有分支名称并不足够。
  • 此处使用大写，分支中使用小写： 跟踪器要求使用规范格式 POD2-2291:。分支名称保持小写，以避免 git 大小写敏感问题。
  • 不使用 feat: / fix:： 工单已经对工作进行了分类。使用两个前缀只会让主题更长。
  • 仅在存在工单时才遵循此规则： 与分支规则相同。不要阻止没有工单的杂务、合并或热修复。
  • 每次提交一个工单，而不是每个分支一个： Jira 会根据主题中的键将提交关联到工单。如果一个 PR 涉及多个工单，每次提交都应关联到其实际修改的工单。在主题中堆叠多个 ID 会破坏 grep、钩子和关联功能。
  • 正文没有约定： 工单中已有上下文。在 git 中添加第二段内容无助于 Jira 关联，而且很容易被 Agent 臆造。

评论

支持 Markdown