commit-messages

从暂存变更自动生成符合规范的提交信息

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:commit-messages。
它的用途是:从暂存变更自动生成符合规范的提交信息
完整的 Skill 内容见:https://321skill.com/skills/commit-messages/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'帮我生成本次提交的commit message,我已经执行了git add。' 它会读取暂存区的diff,自动识别出修复了用户登录的bug,生成类似 'fix(auth): correct login error when password contains special characters' 的提交信息,并询问是否确认使用。

介绍

在团队协作或个人开发中,编写清晰、规范的提交信息是代码管理的基础,但手动编写容易遗漏或不符合约定格式。本 Skill 能够自动分析 git 暂存区(staged changes)中的代码变更,生成遵循 Conventional Commits 规范的提交信息,帮助开发者快速完成提交,同时保持项目历史的一致性和可读性。

使用方式非常简洁:在完成代码修改并执行 git add 后,运行本 Skill 对应的命令,它会读取暂存文件的差异内容,智能识别变更类型(如 feat、fix、refactor 等),并生成包含 scope 和简短描述的提交信息。开发者只需确认或微调即可直接使用,无需手动回忆规范或反复修改格式。

本 Skill 特别适合需要频繁提交代码的开发者,尤其是团队中要求严格遵循 Conventional Commits 规范的项目。无论是后端开发、前端开发还是全栈开发者,都能显著提升提交效率,并确保每次提交都符合统一标准。对于参与开源项目或需要自动化生成 changelog 的场景,效果尤为突出。

建议在安装后先进行一次测试提交,确认生成的信息符合项目惯例。如果项目有特殊 scope 或自定义类型,可以在配置中调整。本 Skill 依赖 Git 环境,且仅对暂存区中的变更生效,因此请确保在运行前已完成 git add

核心特点

主流提交信息生成工具通常需要手动输入或选择,而本 Skill 直接从暂存区 diff 中自动推断变更类型和范围,减少人工判断,且生成的消息完全遵循 Conventional Commits 标准,无需额外配置。

注意事项

不适用于非 Git 版本控制的场景,也无法处理未暂存的变更,且对二进制文件或大文件 diff 的解析效果有限。

常见问题

如何安装 commit-messages?

通常通过 npm 全局安装:`npm install -g commit-messages`,或在项目目录下作为开发依赖安装。具体请参考仓库 README。

生成的信息不符合项目规范怎么办?

可以在配置文件中自定义类型、scope 和描述模板,覆盖默认规则。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/commit-messages/raw/index.md 读取 commit-messages 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。