git-commit-specification
Installation
SKILL.md
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: 添加流水线模板功能 #1234
# 带范围
feat(process): 添加流水线模板功能 #1234
分支命名
feature/pipeline-template-support # 功能分支
bugfix/build-log-missing # Bug 修复分支
hotfix/critical-security-issue # 热修复分支
PR 提交前准备
# 使用 rebase 精简 commit
git rebase -i HEAD~5
# 同步上游代码
git fetch upstream
git rebase upstream/develop
Checklist
提交代码前确认:
- commit message 符合格式规范
- 关联了 Issue 编号
- 使用 rebase 精简了 commit
- 没有包含敏感信息
- 代码通过本地测试
Related skills
More from tencentblueking/bk-ci
frontend-vue-development
前端 Vue 开发规范,涵盖 Vue 2/3 组件开发、Vuex 状态管理、路由配置、组件通信、样式规范、国际化。当用户进行前端开发、编写 Vue 组件、处理状态管理或实现页面交互时使用。
146design-patterns
BK-CI 项目设计模式实践指南,涵盖工厂模式、策略模式、观察者模式、装饰器模式、模板方法等在项目中的实际应用。当用户学习设计模式、重构代码、设计可扩展架构或理解项目设计时使用。
62backend-microservice-development
后端微服务开发规范,涵盖目录结构、分层架构(API/Service/DAO)、依赖注入、配置管理、Spring Boot 最佳实践。当用户进行后端开发、创建新微服务、编写 Kotlin/Java 代码或设计服务架构时使用。
60database-design
BK-CI 数据库设计规范与表结构指南,涵盖命名规范、字段类型选择、索引设计、分表策略、数据归档。当用户设计数据库表、优化索引、规划分表策略或进行数据库架构设计时使用。
53unit-testing
单元测试编写指南,涵盖 JUnit5/MockK 使用、测试命名规范、Mock 技巧、测试覆盖率要求、TDD 实践。当用户编写单元测试、Mock 依赖、提高测试覆盖率或进行测试驱动开发时使用。
53api-interface-design
API 接口设计规范,涵盖 RESTful 设计原则、URL 命名、HTTP 方法选择、请求响应格式、错误码定义、版本控制。当用户设计 API 接口、定义 Resource 类、编写接口文档或进行接口评审时使用。
51