提交工作流Skill commit-workflow

这个技能提供了一个完整的Git提交工作流程,用于在软件开发中遵循标准创建提交。它包括分析暂存文件、编写格式化的提交消息、更新项目文档,并推荐最佳实践,如保持消息简洁和使用主动语态。关键词:Git提交、提交工作流、版本控制、软件开发、DevOps、团队协作、自动化提交、提交消息格式。

DevOps 0 次安装 0 次浏览 更新于 3/16/2026

name: commit-workflow description: 当用户请求“提交这些更改”、“编写提交消息”、“暂存并提交”、“创建提交”、“提交暂存文件”或运行 /commit-staged 或 /commit-creator 命令时,应使用此技能。

提交工作流

遵循项目标准创建提交的完整工作流程。

流程

  1. 使用提交创建代理

    • 运行 /commit-staged [context] 以自动处理提交
    • 或遵循以下手动步骤
  2. 仅分析暂存文件

    • 检查所有暂存文件:git diff --cached --name-only
    • 读取差异:git diff --cached
    • 完全忽略未暂存的更改
  3. 提交消息格式

    • 第一行:{task-type}: 对整体变更的简要描述
    • 任务类型:feat, fix, refactor, docs, style, test, build
    • 关注“为什么”和“什么”,而不是实现细节
    • 对于复杂变更,在空行后添加要点
  4. 消息示例

    • feat: 实现用户认证系统
    • fix: 解决数据处理管道中的内存泄漏
    • refactor: 重构API处理程序以对齐项目架构
  5. 文档更新

    • 检查 README.md 以获取:
      • 应记录的新功能
      • 不再与实现匹配的过时描述
      • 新依赖项的缺失设置说明
    • 根据暂存更改进行更新
  6. 执行

    • 提交使用 HEREDOC 语法以正确格式化
    • 验证提交消息具有正确格式
    • 不要在提交消息中添加测试计划

最佳实践

  • 编写消息前分析暂存文件
  • 保持第一行简洁(推荐50个字符)
  • 在消息中使用主动语态
  • 如果有助于理解,引用相关代码
  • 每个提交只做一个逻辑变更
  • 确保README反映实现