SuperAPI AI 工具集

commit-workflow

编程与开发

查看项目

更新于 10-16 05:46

技能介绍

用途:在用户提出“提交这些更改”“编写提交信息”“暂存并提交”“创建提交”等需求时,按项目标准完成提交流程。

主要能力与用法:

  1. 可使用 commit-creator 智能体处理提交。
  2. 可运行 /commit-staged [context] 自动处理提交。
  3. 也可按手动步骤操作:先用 git diff --cached --name-only 检查所有已暂存文件,再用 git diff --cached 读取差异,完全忽略未暂存的更改。

提交信息格式:

  • 首行:{type}: brief description(最多 50 字符)。
  • 类型:feat、fix、refactor、docs、style、test、build。
  • 侧重说明“为什么”而非“做了什么”。
  • 尽可能采用一句常规风格加一句动机或发现。
  • 复杂更改可在空行后添加要点。

示例:feat: implement user authentication system;fix: resolve memory leak in data processing pipeline;refactor: restructure API handlers to align with project architecture。

文档更新:检查 README.md,确认新增功能是否需要记录、描述是否已过时、新依赖是否缺少安装说明,并根据已暂存更改按需更新。

执行与最佳实践:提交使用 HEREDOC 语法保证格式;提交前分析已暂存文件;首行保持在 50 字符以内;使用主动语态;必要时引用相关代码;每次提交只做一项逻辑更改;不要在提交信息中添加测试计划;确保 README 反映实现。

限制:资料未说明该技能支持的具体平台、安装方式、收费情况或适用范围,暂未提供。