mcpField
G
git-commit-format

git-commit-format

github.com/somnio-software开发8115 次安装6 天前更新
代码仓库

关于 git-commit-format

git-commit-format 是用于根据变更说明生成 Git 提交信息的 Skill,面向希望按 Conventional Commits 格式编写提交记录的开发者。它生成标题和英文项目符号描述,并规定类型选择及格式要求。

主要功能

  1. 01根据变更说明生成提交信息
  2. 02遵循 Conventional Commits 标题格式
  3. 03按变更内容生成英文描述条目
  4. 04提供提交类型选择指南
  5. 05避免 AI 署名等提交尾注

适用场景

  1. 01为功能变更撰写提交信息
  2. 02为错误修复生成规范标题
  3. 03总结多个代码改动为提交描述

安装

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

$npx skills add https://github.com/somnio-software/somnio-ai-tools --skill git-commit-format

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

详细介绍

Git Commit Format Skill

根据变更说明生成提交消息(标题 + 描述)。


约定

提交标题

遵循 Conventional Commits 规范:

{type}({optional scope}): {short imperative description}
  • 类型: feat、fix、chore、refactor、docs、style、test、perf、ci、build、revert
  • 使用祈使语气:“add”“fix”“remove”,不要使用“added”“fixed”“removed”
  • 最多约 72 个字符
  • 除专有名词外,全部使用小写
  • 末尾不加句号
  • 示例:feat(auth): add biometric login support
提交描述

使用过去时动作词编写项目符号列表:

* Fixed ...
* Added ...
* Changed ...
* Removed ...
  • 仅包含适用于实际变更的项目
  • 每条简洁明确
  • 允许使用的动词:Fixed、Added、Changed、Removed、Updated、Refactored、Migrated、Deprecated
  • 始终使用英语
  • 切勿包含 Co-Authored-By、Signed-off-by,或任何表明提交由 AI Agent 或工具完成的尾注

类型选择指南

类型适用场景
feat新功能
fix修复 Bug
refactor不改变行为的代码变更
chore配置、依赖、工具、维护
test添加或更新测试
docs仅修改文档
style格式、空白字符
perf性能改进
ciCI/CD 变更
build构建系统变更
revert撤销之前的提交

如果变更涉及多个方面,建议拆分为多个提交。


输出格式

feat(flutter): upgrade Flutter SDK to v3.19

* Updated Flutter SDK version to 3.19
* Changed minimum iOS deployment target to 14.0
* Fixed deprecated API usages after upgrade
* Removed unused legacy plugins

提交消息必须在项目符号列表之后结束。不要追加任何 Co-Authored-By、Signed-off-by 或 AI 署名尾注。


示例

用户:“我升级了 Flutter,还必须修复一些已弃用的 API 并更新 iOS 目标版本”

feat(flutter): upgrade Flutter SDK to v3.19

* Updated Flutter SDK version to 3.19
* Changed minimum iOS deployment target to 14.0
* Fixed deprecated API usages after upgrade

用户:“修复了用户没有网络时登录导致崩溃的问题”

fix(auth): handle login crash when offline

* Fixed crash on login screen when no internet connection is available
* Added offline error state to login flow

评论

支持 Markdown