SuperAPI AI 工具集

commit-conventions

通用与其它

查看项目

更新于 10-16 05:53

技能介绍

用途:在用户要求提交改动、编写提交信息或拆分大型改动时,按统一格式生成提交信息,并将大改动分解为小型、依赖有序、彼此独立的原子提交。每次提交都使用 git commit -s -m 带签署。

主要能力:标题格式为 type(component): message。type 仅限 feat、fix、docs、chore、refactor 五种;component 为受影响的模块、包或目录(如 auth、api、parser),无特定范围时可省略;message 使用小写祈使语气,约 60 字符内,句末不加句点。

使用方式:先运行 git status、git diff 与 git diff --staged 了解全部改动,按意图而非文件分组;再拆分为原子提交并按依赖排序(设计/脚手架、接口/契约、实现、集成、测试与文档);为每个提交选择正确的 type 与 component,选择性暂存后执行 git commit -s -m "type(component): message"。提交前用 git config user.name && git config user.email 确认签署信息已设置,若为空需先配置。避免在多个逻辑改动待提交时使用 git add -A。

适用场景:适用于需要可独立审阅、可单独回滚的提交历史,例如为 API 增加限流时先提交配置模型与接口,再提交实现与接入,最后补文档。

限制:提交标题格式与类型限于上述五种;排序层级为准则而非硬性规则,小改动可合并为单个提交;拆分是否合理取决于对改动的理解。