diff --git a/GIT_CONVENTION.md b/GIT_CONVENTION.md new file mode 100644 index 0000000..4597f16 --- /dev/null +++ b/GIT_CONVENTION.md @@ -0,0 +1,482 @@ +# Git 使用规范 + +## 目录 +- [分支命名规范](#分支命名规范) +- [提交信息规范](#提交信息规范) +- [工作流程](#工作流程) +- [代码审查](#代码审查) +- [最佳实践](#最佳实践) + +--- + +## 分支命名规范 + +### 分支类型 + +#### 1. 主分支 +- **master/main**: 生产环境分支，只接受合并，不允许直接提交 +- **develop/dev**: 开发主分支，用于集成所有功能 + +#### 2. 功能分支 (Feature) +``` +feature/功能名称 +feature/功能名称-简短描述 +``` +**示例：** +- `feature/user-login` +- `feature/payment-integration` +- `feature/contacts-friends` + +#### 3. 修复分支 (Bugfix) +``` +bugfix/问题描述 +fix/问题描述 +``` +**示例：** +- `bugfix/login-error` +- `fix/memory-leak` + +#### 4. 热修复分支 (Hotfix) +``` +hotfix/问题描述 +``` +**示例：** +- `hotfix/critical-security-patch` +- `hotfix/payment-bug` + +#### 5. 发布分支 (Release) +``` +release/版本号 +``` +**示例：** +- `release/v1.0.0` +- `release/v2.1.0` + +### 命名规则 +- 使用小写字母 +- 多个单词用连字符 `-` 分隔 +- 避免使用下划线 `_` 或空格 +- 分支名要有意义，能清楚表达分支用途 +- 避免使用特殊字符：`~`, `^`, `:`, `?`, `*`, `[`, `\` + +--- + +## 提交信息规范 + +### 提交信息格式 +``` +(): + + + +