提交信息助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/commit-messages
技能介绍
为什么需要规范的提交信息
在日常开发中,团队协作和代码审查常常面临一个隐性问题:提交历史中的 commit message 格式混乱、信息模糊。手动编写时容易忘记统一规范,或者为了图快写出类似「fix bug」「update code」这样缺乏上下文的描述。这导致后续回溯问题、生成 changelog 或执行自动化发布时,需要额外花时间猜测每条提交的意图。
技能如何生成符合规范的提交信息
当你准备提交代码时,这个技能会主动介入并执行以下步骤:
- 运行
git diff --staged分析当前暂存区的变更内容,而非依赖你的主观描述 - 根据变更的性质判断 commit type,例如新增功能对应
feat,修复缺陷对应fix,文档更新对应docs - 识别变更主要影响的代码模块作为 scope,比如
auth、api、db或ui - 按照 Conventional Commits 规范生成结构化的提交信息,包括可选的 body 和 footer
生成的 message 会遵循严格的格式要求:使用祈使句("add" 而非"added")、首字母不大写、结尾不加句号、总长度控制在 72 字符以内。如果涉及 breaking change 或需要关联 issue,技能会自动添加相应的 footer 标签。
适用场景与注意点
这个技能适用于所有需要执行 git commit 的场景,尤其是当你希望保持提交历史清晰可读时。它会在你提到 "commit"、"write a commit message" 或准备运行任何 git commit 命令之前自动触发。
需要注意,技能只分析已暂存的文件变更,不会主动暂存任何文件。如果变更涉及多个不相关的模块,可能需要你在生成后手动调整 scope 部分。此外,虽然技能能根据变更内容推荐合适的 type,但最终的判断仍需结合你对业务逻辑的理解,避免将重构误判为功能新增。
使用场景
- 代码改动完成准备提交时,需要生成符合团队规范的 commit message
- 修改了 bug 需要修复缺陷并关联 issue,希望提交信息包含类型和作用域
- 新增功能模块开发完毕,要撰写 feat 类型的提交说明并指定 scope
- 提交涉及破坏性变更,需要生成包含 BREAKING CHANGE 的提交信息
适合人员
- 前端工程师,需要保持个人提交历史风格统一
- 开源项目维护者,要求所有贡献者遵循 Conventional Commits 规范
- 后端开发者,经常需要快速撰写包含 body 和 footer 的详细提交信息
- 团队技术负责人,希望在代码审查时看到清晰可追溯的提交记录