mcpField
C
commit-workflow

commit-workflow

github.com/fcakyon开发1.2k45 次安装今天更新
代码仓库

关于 commit-workflow

用于按项目规范创建提交的技能，涵盖暂存更改审查、提交信息编写和 README 更新。

主要功能

  1. 01审查暂存文件与差异
  2. 02编写简洁的提交信息
  3. 03检查 README 是否需更新
  4. 04核对提交信息格式

适用场景

  1. 01为暂存更改准备提交
  2. 02统一提交信息格式
  3. 03随代码更改更新文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/fcakyon/claude-codex-settings --skill commit-workflow

安装后在 Claude Code 中输入/commit-workflow确认已加载。

详细介绍

提交工作流

按照项目标准创建提交的完整工作流。

流程

  1. 使用 commit-creator agent

    • 运行 /commit-staged [context] 自动处理提交
    • 或按照下面的手动步骤操作

  2. 仅分析已暂存文件

    • 检查所有已暂存文件：git diff --cached --name-only
    • 查看差异：git diff --cached
    • 完全忽略未暂存的更改

  3. 提交信息格式

    • 第一行：{type}: brief description（最多 50 个字符）
    • 类型：feat、fix、refactor、docs、style、test、build
    • 重点说明“为什么”，而非“做了什么”
    • 尽可能采用 1 句常规格式的描述，再加 1 句动机／发现
    • 对于复杂更改，在空行后添加项目符号列表

  4. 信息示例

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

  5. 更新文档

    • 检查 README.md 中是否存在：
      • 应记录的新功能
      • 已过时、与当前实现不符的描述
      • 新依赖项缺少的设置说明
    • 根据已暂存的更改按需更新

  6. 执行

    • 使用 HEREDOC 语法提交，以正确设置格式
    • 确认提交信息格式正确
    • 不要在提交信息中添加测试计划

最佳实践

  • 编写信息前先分析已暂存文件
  • 第一行控制在 50 个字符以内
  • 使用主动语态
  • 如有帮助，可引用相关代码
  • 每次提交只包含一项逻辑更改
  • 确保 README 与实际实现一致

评论

支持 Markdown