mcpField
G
git-commit

git-commit

github.com/fredrikaverpil开发25942 次安装3 天前更新
代码仓库

关于 git-commit

用于编写符合 Conventional Commits 规范的 Git 提交信息,涵盖主题、正文、破坏性变更和署名规则,适合希望统一提交与分支命名的贡献者。

主要功能

  1. 01Conventional Commits 格式
  2. 02提交类型与范围说明
  3. 03主题和正文规则
  4. 04破坏性变更标记
  5. 05分支命名规范
  6. 06身份与签名保护

适用场景

  1. 01编写功能或修复提交
  2. 02说明破坏性变更
  3. 03为计划中的工作命名分支

安装

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

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

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

详细介绍

Git 提交消息

请按照 Conventional Commits 规范编写提交消息。

格式

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

类型

类型用途
feat新功能
fix修复错误
docs仅修改文档
style代码风格(格式调整,不改变逻辑)
refactor代码变更,既不修复错误也不添加功能
perf性能改进
test添加或修正测试
build构建系统或外部依赖
ciCI 配置
chore维护任务
revert撤销之前的提交

规则

  1. 描述使用祈使语气(写“add feature”,而不是“added feature”)
  2. 描述末尾不要加句号
  3. 描述长度不超过 72 个字符
  4. 主题与正文之间空一行
  5. 正文用于说明变更的意图、细节、注意事项或背景,不要只是换种说法复述差异

破坏性变更

在类型/范围后添加 !,或在页脚中加入 BREAKING CHANGE::

feat(api)!: remove deprecated endpoints

BREAKING CHANGE: The /v1/users endpoint has been removed.

范围

可选。用于指定变更范围(例如:api、ui、auth、db)。

分支命名

创建新分支时,使用 <type>/<kebab-description> 命名,并采用与提交消息相同的类型(例如:feat/add-user-auth、 fix/broken-symlinks)。

例外:如果环境已分配分支(例如 Claude 云沙盒会话中的 claude/... 分支),请保留该分支,不要重命名,也不要为了符合此约定而创建其他名称的分支。

身份、签名与署名

Git 身份和提交签名由环境配置(开发者机器上的 gitconfig、云沙盒中的 SessionStart 钩子),请交由环境处理:

  1. 消息只描述变更:不要添加 Co-Authored-By、"Generated with" 行、会话链接或模型名称。
  2. 让 git 从配置中解析作者信息——提交时不要使用 --author 或 -c user.name=.../-c user.email=...。
  3. 让 git 从配置中解析签名设置——提交时不要使用 -S、--gpg-sign 或 --no-gpg-sign,也不要更改与签名相关的配置。

评论

支持 Markdown