SuperAPI AI 工具集

git-commit

编程与开发

查看项目

更新于 10-16 06:17

技能介绍

用途:按 Conventional Commits 规范创建规范化的语义化 Git 提交,分析实际 diff 以确定合适的类型、范围和提交信息。

主要能力:支持标准提交格式 <type>[optional scope]: <description>,以及可选的正文与页脚;覆盖 feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert 等类型;支持破坏性变更标记(类型/范围后加感叹号,或使用 BREAKING CHANGE 页脚)。

使用方式:先分析 diff,已暂存用 git diff --staged,未暂存用 git diff,并用 git status --porcelain 查看状态;按需暂存文件,可用 git add path/to/file1 path/to/file2、git add .test.、git add -p;再根据 diff 判断类型、范围与描述,生成提交信息;最后执行 git commit -m "<type>[scope]: <description>",多行信息可用 heredoc 形式传入。

适用场景:用户要求提交更改、创建 Git 提交,或需要按规范整理提交流程时。

限制与安全:不要提交机密文件(如 .env、credentials.json、私钥);不要更新 git 配置;未经明确要求不要执行破坏性命令(--force、硬重置);除非用户要求,不要跳过钩子(--no-verify);不要强制推送到 main/master;若因钩子导致提交失败,应修复后创建新提交而非 amend。最佳实践为每次提交一个逻辑变更,描述使用现在时、祈使语气,控制在 72 字符以内,并可用 Closes #123、Refs #456 引用 issue。