mcpField
G
git-commit

git-commit

github.com/dhruvanbhalara开发30131 次安装10 周前更新
代码仓库

关于 git-commit

git-commit 是一项指导自动化 Git 提交的技能,围绕 Conventional Commits 规范组织变更。它涵盖按范围分组、选择性暂存、编写提交说明及检查历史记录的流程。

主要功能

  1. 01按逻辑范围分组变更
  2. 02遵循 Conventional Commits
  3. 03选择性暂存文件
  4. 04为复杂变更编写提交正文
  5. 05检查最近提交历史

适用场景

  1. 01按功能或模块拆分提交
  2. 02为代码变更生成规范提交说明
  3. 03确保提交只包含目标文件
  4. 04提交后检查 Git 历史

安装

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

$npx skills add https://github.com/dhruvanbhalara/skills --skill git-commit

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

详细介绍

自动化 Git 提交

本技能提供有关如何按照 Conventional Commits 规范执行原子化、结构清晰的 Git 提交的说明。

1. 分析变更

  • 识别已修改的文件:运行 git status --short,查看所有已暂存和未暂存的变更。
  • 遵守忽略规则:不要包含用户明确要求忽略的文件,也不要包含符合 .gitignore 模式的文件。
  • 按范围分组:根据逻辑上的“范围”(例如特定模块、功能或层,如 data、domain、ui)对已修改的文件分组。

2. 分支管理

  • 功能分支:始终从 main 创建描述性功能分支(例如 feat/login-logic)。
  • 合并流程:只有在通过所有质量检查并获得 PR 批准后,才合并回 main。

3. 生成提交消息

  • Conventional Commits:每次提交都必须遵循以下模式:<type>(<scope>): <message>。
    • 类型:feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert。
    • 范围:被修改的模块或区域(例如 auth、api)。
    • 消息:使用祈使语气简洁描述变更。
  • 附加消息(提交正文):
    • 如果变更涉及逻辑、破坏性变更或多个步骤,务必添加详细正文。
    • 说明变更的“内容”“原因”和“方式”。
    • 使用空行分隔主题和正文。

3. 原子化提交

  • 每次提交一个范围:对不同范围分别提交。
  • 选择性暂存:只暂存属于当前范围的文件。

4. 执行流程

  • 步骤 1:按范围对文件分组。
  • 步骤 2:针对每个分组:
    • 暂存文件。
    • 生成 Conventional Commits 格式的提交消息(主题和正文)。
    • 执行:
      git commit -m "<subject>" -m "<body>"
      
  • 步骤 3:验证历史记录(git log -n 5)。

评论

支持 Markdown