| name | git-commit-specification |
| description | Git 提交规范,涵盖 commit message 格式(feat/fix/refactor)、Issue 关联、分支命名、PR 提交准备、rebase 使用。当用户提交代码、编写 commit message、创建分支或准备 PR 时使用。 |
Git 提交规范
Quick Reference
格式:标记: 提交描述 #issue编号
示例:feat: 添加流水线模板功能 #1234
分支:feature/xxx | bugfix/xxx | hotfix/xxx
标记类型
| 标记 | 说明 | 示例 |
|---|
feat | 新功能 | feat: 添加流水线模板支持 #1234 |
fix | Bug 修复 | fix: 修复构建日志丢失 #5678 |
refactor | 重构 | refactor: 优化查询性能 |
perf | 性能优化 | perf: 减少数据库查询 |
test | 测试 | test: 添加单元测试 |
docs | 文档 | docs: 更新 API 文档 |
chore | 构建/工具 | chore: 更新 Gradle 配置 |
del | 破坏性删除 | del: 移除废弃 API(需特别批准) |
When to Use
- 提交代码
- 创建分支
- 准备 PR
- 编写 commit message
提交格式
feat: 添加流水线模板功能
feat(process): 添加流水线模板功能
分支命名
feature/pipeline-template-support
bugfix/build-log-missing
hotfix/critical-security-issue
PR 提交前准备
git rebase -i HEAD~5
git fetch upstream
git rebase upstream/develop
Checklist
提交代码前确认: