weijuesen
43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
|
|
# Git 使用规范（本仓库）
|
|
|
|
## 1、分支模型
|
|
|
|
- `master`：稳定主分支，只接受经评审后的合并，不直接提交开发代码。
|
|
- `develop`：开发集成分支，日常开发默认从它拉分支、合回。
|
|
- 功能分支：`feature/<简短描述>`，从 `develop` 拉出，完成后合回 `develop`。
|
|
- 修复分支：`bugfix/<简短描述>`，从 `develop` 拉出。
|
|
- 紧急修复：`hotfix/<简短描述>`，从 `master` 拉出，修复后合回 `master` 与 `develop`。
|
|
- 发布分支：`release/<版本号>`，从 `develop` 拉出，测试通过后合回 `master` 并打标签 `v<版本号>`。
|
|
|
|
## 2、首次克隆与开分支
|
|
|
|
```bash
|
|
git clone <仓库地址>
|
|
git checkout -b feature/my-feature develop # 从 develop 拉功能分支
|
|
```
|
|
|
|
## 3、日常提交
|
|
|
|
```bash
|
|
git add <文件> # 只添加本次改动相关文件，不要 git add -A 一把梭
|
|
git commit -m "feat: 新增xxx" # 提交信息格式：type: 描述
|
|
git pull --rebase origin develop # 合入前先同步远端
|
|
git push -u origin feature/my-feature
|
|
```
|
|
|
|
提交信息前缀：`feat`（功能）、`fix`（修复）、`docs`（文档）、`refactor`（重构）、`test`（测试）、`chore`（杂项）。
|
|
|
|
## 4、合并与评审
|
|
|
|
- 通过合并请求（MR/PR）把功能分支合入 `develop`，由他人评审后合并。
|
|
- 不要把自己的个人分支长期保留在共享远端；合并后删除。
|
|
- 合入前确保已通过对应模块的验证命令（见 AGENTS.md「验证」）。
|
|
|
|
## 5、与远端同步
|
|
|
|
```bash
|
|
git fetch origin
|
|
git pull --rebase origin develop
|
|
```
|