home / skills / tencentblueking / bk-ci / git-commit-specification

git-commit-specification skill

safe

This skill helps standardize git commit messages, branch naming, and PR readiness to streamline code reviews and issue tracking.

npx playbooks add skill tencentblueking/bk-ci --skill git-commit-specification

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

1.8 KB

---
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

```
格式：标记: 提交描述 #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

---

## 提交格式

```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
- [ ] 没有包含敏感信息
- [ ] 代码通过本地测试

Overview

This skill enforces a concise Git commit and branch specification for teams. It defines commit message formats (feat/fix/refactor/etc.), branch naming conventions, Issue linking, PR preparation steps, and rebase guidance. The goal is consistent history, clearer reviews, and easier release notes.

How this skill works

The skill inspects commit messages, branch names, and PR readiness against the agreed format. It checks for a type prefix (e.g., feat:, fix:, refactor:), optional scope, and an Issue number reference. It also guides contributors to use rebase for a tidy history and to run local tests before creating a PR.

When to use it

When creating or updating a branch for a feature, bugfix, or hotfix
When writing commit messages for code changes
When preparing a pull request for review and merging
When rebasing to clean up multiple commits before merge
When linking work to an Issue tracker for traceability

Best practices

Start commit messages with a type: feat, fix, refactor, perf, test, docs, chore, or del (del requires approval)
Include an optional scope in parentheses for component-level context, e.g., feat(process): description
Append the Issue number at the end, e.g., feat: add pipeline template support #1234
Use branch prefixes: feature/, bugfix/, or hotfix/ followed by a short kebab-case description
Use interactive rebase (git rebase -i) to squash or tidy commits, then fetch and rebase against upstream before pushing
Run local tests and strip sensitive data before creating a PR

Example use cases

Creating a feature branch: feature/pipeline-template-support and committing as feat: add pipeline template support #1234
Fixing a bug in a bugfix branch and using fix: restore missing build logs #5678
Refactoring code with refactor: optimize query performance and grouping related changes before PR
Preparing a clean PR by squashing interim commits via git rebase -i and rebasing onto develop
Updating docs or tests with docs: update API docs or test: add unit tests without linking an Issue if unnecessary

FAQ

What types should I use for commits?

Use feat, fix, refactor, perf, test, docs, chore, or del. Reserve del for breaking removals that need special approval.

How do I format an issue link?

Append the Issue number at the end of the commit message, e.g., feat: add feature X #1234.