Open Skills Logo
Open Skillsopenskills.cc
技能commit
C

commit

遵循Sentry规范的提交信息。适用于提交代码变更、撰写提交信息或格式化Git历史记录时。采用约定式提交格式，并包含Sentry特有的问题引用。

Sentry Commit Message 规范指南

技能概述

遵循 Sentry 约定的 commit message 规范编写 git 提交信息，支持 conventional commits 格式和 Sentry issue 引用。

适用场景

  1. 提交代码变更时：按照标准格式编写 commit message，确保团队提交历史清晰一致
  2. 关联 Sentry 问题：在 commit footer 中引用 SENTRY、GitHub 或 Linear issue，自动关闭或关联工单
  3. AI 辅助开发：使用 Claude Code 等 AI 工具生成代码时，正确添加 Co-Authored-By 声明

核心功能

  1. 规范化 commit 格式：提供统一的 <type>(<scope>): <subject> 格式，支持 12 种 commit 类型（feat、fix、ref、perf、docs、test、build、ci、chore、style、meta、license）
  2. Sentry issue 引用：通过 Fixes 或 Refs 关键字关联 SENTRY-xxxx、GH-xxxx、LINEAR-xxx 等问题追踪系统
  3. 破坏性变更标记：使用 ! 符号或 BREAKING CHANGE footer 明确标注不兼容的 API 变更

常见问题

commit subject 有哪些规则？

使用祈使句现在时态（"Add" 而非 "Added"），首字母大写，末尾不加句号，最长 70 字符。

feat、fix、ref 等 commit 类型有什么区别？

  • feat：新功能
  • fix：缺陷修复
  • ref：重构（无行为改变）
  • perf：性能优化
  • docs：仅文档变更
  • test：测试相关
  • 其他类型包括 build、ci、chore、style、meta、license

AI 生成的代码应该如何提交？

在 commit footer 添加 Co-Authored-By: Claude <noreply@anthropic.com>，不要在 subject 或 body 中使用 "Generated by AI" 等表述。