SuperAPI AI 工具集

inkblot-commit-message

写作与研究

查看项目

更新于 10-15 22:38

技能介绍

用途:该技能定义 Inkblot 的 Git 提交信息约定,适用于撰写提交信息、创建 git commit、修改提交信息,或用户询问格式时。

主要能力与规则:仅当工作关联 Jira 工单时才强制此约定。有工单时格式为“<TICKET-ID>: <简洁祈使句摘要>”,工单号须为完整 Jira key、全大写,一次提交只对应一个工单,例如 POD2-2291,而非 pod2-2291 或 2-2291。工单号后跟冒号和空格,再接祈使句摘要(如 Fix…、Add…、Rename…),使用句首大写、单行、约 72 字符,说明结果而非文件清单。主题中写本次提交所属工单,而非 PR 上所有工单,也不总是分支名。不使用 Conventional Commits 前缀(feat:、fix:、chore:),工单本身即分类。

多工单处理:一个分支或 PR 可关联多个工单,但每次提交仍只写一个 key,即该提交实现或修复的工单。默认使用分支工单;若本次提交属于另一关联工单,则切换为该 key;若不确定属于哪个工单,应询问,不得编造 ID,也不得堆叠 key(如 POD2-2276-2277:)。

正文:无规则,不要求正文,除非用户要求否则不添加,上下文放在 Jira。

禁止项(仅工单工作):不用 feat:/fix: 前缀;工单号须大写;不得使用非 Jira key 形式;用冒号而非连字符;优先祈使句;主题只放一个主工单;不得编造工单 ID。校验正则:^[A-Z][A-Z0-9]+-[0-9]+: .+

无工单:无主题规则,合并提交、同步及其他未跟踪工作可使用任意主题。

原因:Jira Smart Commits 与 GitHub–Jira 链接读取提交主题,分支名不够;跟踪器期望规范的大写形式,分支保持小写以避免 git 大小写敏感问题;工单已分类工作,无需额外前缀;仅在存在工单时适用规则,不阻塞无工单的杂项、合并或热修复;一次提交一个工单,便于 grep、钩子和关联。

限制:资料未提供安装命令、平台支持、收费或价格信息。