@eamode/pi-commit

支持子模块的自动生成友好变更日志的提交工具

安装使用

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

帮我安装这个 AI Skill:@eamode/pi-commit。
它的用途是:支持子模块的自动生成友好变更日志的提交工具
完整的 Skill 内容见:https://321skill.com/skills/eamode-pi-commit/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

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

使用示例

‘帮我把今天的修改用规范格式提交,主要新增了用户登录功能’,它会引导你确认变更类型为‘feat’,影响范围为‘auth’,并自动生成如‘feat(auth): add user login functionality’的提交信息,完成提交。

介绍

这个 Skill 解决了开发者在提交代码时,手动编写符合 Conventional Commits 规范的提交信息繁琐且易错的问题。它通过自动化流程,确保每次提交都遵循标准格式,便于后续自动生成清晰的变更日志(Changelog)。

使用方式非常简单,在配置好项目后,运行相应的命令即可。它会引导你选择或输入提交类型(如 feat, fix)、影响范围、描述等信息,并自动生成格式规范的提交消息,无需手动拼接。对于包含 Git 子模块的项目,它还能智能地处理子模块的变更,确保提交记录的完整性。

它非常适合所有使用 Git 进行版本控制、并希望保持提交历史清晰、规范,特别是团队协作的项目。无论是前端、后端还是全栈开发者,只要项目有生成自动化变更日志或需要更清晰的提交历史追溯的需求,都能从中受益。

建议在项目初期或引入规范时集成此工具,并让团队成员熟悉其工作流。注意,它主要优化的是提交信息的生成过程,项目本身仍需配置好如 commitlint 等验证工具来强制规范。对于极其简单或个人随意记录的项目,可能略显繁琐。

核心特点

核心区别在于原生支持 Git 子模块的变更检测与提交信息整合,能自动识别并处理包含子模块的仓库的提交,而同类工具通常需要额外配置或无法优雅处理子模块场景。

注意事项

不适合不遵循 Conventional Commits 规范或提交流程极其简单固定的项目。

常见问题

这个工具和 commitizen 有什么区别?

它专注于与特定开发环境(pi)集成,并提供了对 Git 子模块的原生支持,而 commitizen 是一个更通用的提交规范工具。

需要预先配置 commitlint 吗?

不需要,此工具负责生成规范信息,但结合 commitlint 可以构成完整的提交规范检查流程。

给 AI 助手的安装指引

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

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