Back to Details

git-commit-specification

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Git 提交规范

Git Commit Specification

Quick Reference

Quick Reference

格式：标记: 提交描述 #issue编号
示例：feat: 添加流水线模板功能 #1234
分支：feature/xxx | bugfix/xxx | hotfix/xxx
Format: Tag: Commit description #Issue number
Example: feat: Add pipeline template feature #1234
Branches: feature/xxx | bugfix/xxx | hotfix/xxx

标记类型

Tag Types

标记说明示例
feat
新功能
feat: 添加流水线模板支持 #1234
fix
Bug 修复
fix: 修复构建日志丢失 #5678
refactor
重构
refactor: 优化查询性能
perf
性能优化
perf: 减少数据库查询
test
测试
test: 添加单元测试
docs
文档
docs: 更新 API 文档
chore
构建/工具
chore: 更新 Gradle 配置
del
破坏性删除
del: 移除废弃 API
（需特别批准）
TagDescriptionExample
feat
New feature
feat: Add pipeline template support #1234
fix
Bug fix
fix: Fix build log missing issue #5678
refactor
Code refactoring
refactor: Optimize query performance
perf
Performance optimization
perf: Reduce database queries
test
Testing
test: Add unit tests
docs
Documentation
docs: Update API documentation
chore
Build/tooling
chore: Update Gradle configuration
del
Destructive deletion
del: Remove deprecated API
(requires special approval)

When to Use

When to Use

  • 提交代码
  • 创建分支
  • 准备 PR
  • 编写 commit message
  • Submit code
  • Create a branch
  • Prepare a PR
  • Write commit messages

提交格式

Commit Format

bash
undefined
bash
undefined

标准格式

Standard format

feat: 添加流水线模板功能 #1234
feat: Add pipeline template feature #1234

带范围

With scope

feat(process): 添加流水线模板功能 #1234
undefined
feat(process): Add pipeline template feature #1234
undefined

分支命名

Branch Naming

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

PR 提交前准备

Preparations Before PR Submission

bash
undefined
bash
undefined

使用 rebase 精简 commit

Use rebase to streamline commits

git rebase -i HEAD~5
git rebase -i HEAD~5

同步上游代码

Sync upstream code

git fetch upstream git rebase upstream/develop

---
git fetch upstream git rebase upstream/develop

---

Checklist

Checklist

提交代码前确认：
  • commit message 符合格式规范
  • 关联了 Issue 编号
  • 使用 rebase 精简了 commit
  • 没有包含敏感信息
  • 代码通过本地测试
Confirm before submitting code:
  • commit message complies with format specifications
  • Linked Issue number
  • Used rebase to streamline commits
  • No sensitive information included
  • Code passed local tests