mcpField
W
writing-git-commits

writing-git-commits

github.com/zenobi-us开发6836 次安装今天更新
代码仓库

关于 writing-git-commits

这项技能指导按 Conventional Commits 编写提交信息，让变更意图清晰且便于工具解析。内容涵盖入门说明、示例、规范和常见问题。

主要功能

  1. 01Conventional Commits 格式与类型
  2. 02范围和提交意图指引
  3. 03SemVer 与发布工具相关说明
  4. 04摘要、示例、规范和常见问题

适用场景

  1. 01在团队中编写一致的提交信息
  2. 02为自动生成变更日志准备提交
  3. 03支持与 SemVer 关联的发布工作流

安装

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

$npx skills add https://github.com/zenobi-us/dotfiles --skill writing-git-commits

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

详细介绍

编写优秀的 Git 提交信息

掌握语义化提交信息的编写技巧，让人和机器都能理解提交意图。遵循 Conventional Commits 规范创建提交，从而支持自动化工具、清晰的历史记录和高效协作。

什么是 Conventional Commits？

Conventional Commits 是一套轻量级规范，用于为提交信息添加人类和机器均可识别的含义。它通过一组简单规则，帮助创建明确的提交历史，从而：

  • 让自动化工具能够解析提交并执行相应操作
  • 让人们一眼就能看懂代码历史
  • 与语义化版本（SemVer）保持一致，以便自动管理版本发布
  • 推动更有条理的开发实践

子技能

  • 概览：快速了解规范和核心概念

    • → 查看 ./summary/SKILL.md
      • 或者在需要时使用 skill_use(superpowers_writing_git_commits_summary)

  • 示例：不同场景下的真实提交信息示例

    • → 查看 ./examples/SKILL.md
      • 或者在需要时使用 skill_use(superpowers_writing_git_commits_examples)

  • 规范：包含所有规则和要求的完整技术规范

    • → 查看 ./specification/SKILL.md
      • 或者在需要时使用 skill_use(superpowers_writing_git_commits_specification)

  • 常见问题：常见问题解答和实用指导

    • → 查看 ./faq/SKILL.md
      • 或者在需要时使用 skill_use(superpowers_writing_git_commits_faq)

基本结构

每条提交信息都应遵循以下格式：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

核心提交类型

  • feat：引入新功能（在 SemVer 中对应 MINOR）
  • fix：修复错误（在 SemVer 中对应 PATCH）
  • BREAKING CHANGE：重大破坏性变更（在 SemVer 中对应 MAJOR）
  • docs：文档变更
  • style：代码风格变更（格式调整、缺少分号等）
  • refactor：不涉及功能变更的代码重构
  • perf：性能改进
  • test：添加或更新测试
  • chore：构建、依赖项或工具变更
  • ci：CI/CD 配置变更

何时使用此技能

在以下情况下使用 Conventional Commits 规范：

  • 为版本控制的代码编写语义化提交信息
  • 在需要清晰提交历史的团队中协作
  • 构建用于解析提交信息的自动化工具
  • 与语义化版本实践集成
  • 自动生成 CHANGELOG
  • 向利益相关者说明变更性质

如何应用

  1. 阅读概览，快速了解核心概念
  2. 查看示例，了解不同场景如何对应提交类型
  3. 查阅规范，了解详细规则和技术要求
  4. 查阅常见问题，获取常见问题的解答和最佳实践

核心原则

✅ 清晰明确：提交信息应清楚说明变更内容和原因 ✅ 保持一致：所有提交都使用同一套规范 ✅ 结构化：遵循类型/范围/描述格式 ✅ 原子化：尽可能让每条提交只包含一项逻辑变更 ✅ 机器可读：支持自动化工具和分析

与工作流集成

/project:do:commit 会引用此技能，指导你创建语义化提交，保持提交历史清晰有序，并支持用于版本发布管理和变更日志生成的自动化工具。

许可证：Creative Commons - CC BY 3.0

来源：Conventional Commits v1.0.0

评论

支持 Markdown