AgentSkillsCN

git-commit-specification

Git提交规范,涵盖commit message格式(feat/fix/refactor)、Issue关联、分支命名、PR提交准备、rebase使用。当用户提交代码、编写commit message、创建分支或准备PR时使用。

SKILL.md
--- frontmatter
name: git-commit-specification
description: Git 提交规范,涵盖 commit message 格式(feat/fix/refactor)、Issue 关联、分支命名、PR 提交准备、rebase 使用。当用户提交代码、编写 commit message、创建分支或准备 PR 时使用。
related_skills: []
token_estimate: 1200

Git 提交规范

Quick Reference

code
格式:标记: 提交描述 #issue编号
示例:feat: 添加流水线模板功能 #1234
分支:feature/xxx | bugfix/xxx | hotfix/xxx

标记类型

标记说明示例
feat新功能feat: 添加流水线模板支持 #1234
fixBug 修复fix: 修复构建日志丢失 #5678
refactor重构refactor: 优化查询性能
perf性能优化perf: 减少数据库查询
test测试test: 添加单元测试
docs文档docs: 更新 API 文档
chore构建/工具chore: 更新 Gradle 配置
del破坏性删除del: 移除废弃 API(需特别批准)

When to Use

  • 提交代码
  • 创建分支
  • 准备 PR
  • 编写 commit message

提交格式

bash
# 标准格式
feat: 添加流水线模板功能 #1234

# 带范围
feat(process): 添加流水线模板功能 #1234

分支命名

bash
feature/pipeline-template-support   # 功能分支
bugfix/build-log-missing            # Bug 修复分支
hotfix/critical-security-issue      # 热修复分支

PR 提交前准备

bash
# 使用 rebase 精简 commit
git rebase -i HEAD~5

# 同步上游代码
git fetch upstream
git rebase upstream/develop

Checklist

提交代码前确认:

  • commit message 符合格式规范
  • 关联了 Issue 编号
  • 使用 rebase 精简了 commit
  • 没有包含敏感信息
  • 代码通过本地测试