Agent Skills
返回列表
代码改动提交说明生成

代码改动提交说明生成

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_fccf428b/commit-message。

技能介绍

为什么需要自动化提交说明生成

在日常开发中,Git 提交记录(Commit Message)是团队协作和代码审查的重要依据。然而,手动编写符合 Conventional Commits 规范的提交说明往往耗费精力,且容易因为主观疏忽导致格式不统一或描述模糊。开发者经常面临“代码改完了,但不知道如何精准概括这次改动”的困境,劣质的提交信息会让后续的 git log 和自动化版本生成变得混乱。

核心工作流与能力

该技能专注于分析暂存区(Staging Area)的代码差异,并自动生成符合规范的提交说明。其核心工作流包含以下关键步骤:

  • 差异分析:通过 git diff --cached --stat 快速评估变更文件范围,随后执行 git diff --cached 深入查看具体的代码改动内容。
  • 类型判定:根据 diff 内容,准确识别本次提交的类型(如 feat、fix、refactor、docs 等)。
  • 规范输出:撰写不超过 72 个字符的祈使句主题行(Subject Line),并补充说明“为什么做此改动”的正文段落(Body)。
  • 纯文本交付:最终输出为纯净的文本格式,直接适配 git commit -m 命令,无需任何代码块包裹。

适用边界与安全注意

作为开发者的辅助工具,该技能严格遵循只读分析和建议原则。它不会自动安装依赖、修改系统权限或创建持久化后台任务。涉及代码执行时,命令仅作为参考,必须在用户明确要求且目标范围清晰时才可运行。此外,对于涉及发送、发布、删除或部署等外部写入操作,技能会先展示目标与潜在影响,并强制要求用户明确确认,确保开发流程的安全可控。

使用场景

  • 代码改完并执行 `git add` 后,需要快速生成符合 Conventional Commits 规范的提交说明
  • 解决完一个 bug 后,希望自动识别改动类型并写出清晰解释原因的 commit body
  • 团队要求所有提交遵循统一规范,需要工具帮忙判断当前改动属于 feat 还是 fix
  • 提交前发现暂存区有多个文件变更,需要检查 diff 并生成一条逻辑连贯的提交信息

适合人员

  • 后端工程师,希望减少每次提交时斟酌措辞的时间,同时保持提交历史清晰可读
  • 开源项目维护者,需要确保贡献者的 commit 格式统一,便于生成 changelog 和追踪问题
  • 刚转入团队的开发者,还不熟悉团队的 Conventional Commits 约定,需要辅助工具避免格式返工