SuperAPI AI 工具集

commit-message-generator

编程与开发

查看项目

更新于 10-16 06:55

技能介绍

用途

commit-message-generator 是一个用于根据 Git 差异生成提交信息的技能。它读取当前仓库的改动内容,分析后给出符合规范的提交信息建议,帮助开发者快速写出结构清晰、语义明确的 commit message。

主要能力

  • 运行 git status 检查已修改的文件。
  • 通过 git diff 或 git diff --cached 获取差异内容。
  • 分析差异内容,判断改动是否应拆分为多个提交。
  • 为每组逻辑变更生成英文提交信息,格式遵循 Conventional Commits。
  • 提交信息结构为:一行 Conventional Commits 头部、可选的空行第二行、从第三行开始用项目符号列出变更摘要。
  • 针对每组变更,列出目标文件并建议执行命令:git add <files> && git commit -m "<message>"。
  • 当改动范围较大需要拆分时,提供拆分理由以及多个提交建议,每个建议包含目标文件与对应信息。

使用方式

该技能按以下步骤工作:

  1. 运行 git status 检查已修改文件。
  2. 使用 git diff 或 git diff --cached 获取差异。
  3. 分析差异内容,判断是否需要拆分为多个提交。
  4. 对每个逻辑变更组:列出目标文件;生成符合 Conventional Commits 的英文提交信息;建议命令 git add <files> && git commit -m "<message>"。
  5. 若改动广泛且应拆分,则给出拆分理由和多个提交建议。

提交拆分准则

  • 当改动涉及多个逻辑关注点(例如功能开发与重构)时,应拆分提交。
  • 将服务于同一目的的相关文件归为一组。
  • 每个提交应聚焦于单一、原子的变更。

适用场景

适用于需要按 Conventional Commits 规范撰写英文提交信息的 Git 工作流,尤其适合改动较多、需要判断是否拆分提交的场合。

限制

  • 该技能绝不执行 git commit 或 git push。
  • 仅提供命令建议,是否执行完全由用户自行决定。
  • 用户必须自行显式执行提交与推送操作。
  • 提交信息必须使用英文。
  • 提交信息格式必须遵循 Conventional Commits。

暂未提供的信息

关于该技能的安装方式、收费模式、支持平台等具体信息,资料中暂未提供。