140 lines
3.4 KiB
Markdown
140 lines
3.4 KiB
Markdown
# Git 快速参考（AI 用）
|
||
|
||
> 从 [GIT-GUIDE.md](GIT-GUIDE.md) 精简。完整规范见原文。
|
||
|
||
---
|
||
|
||
## 分支策略
|
||
|
||
**develop 长期开发分支模型** — 单人开发 + 多 Agent 协作。
|
||
|
||
```
|
||
main ─────────── 永远可玩可编译，受保护，禁止直接推送
|
||
│
|
||
│ PR (Gitea) ← 里程碑/迭代结束时，PM 发起
|
||
│
|
||
└── develop ──── 长期分支，所有 agent 在此工作
|
||
```
|
||
|
||
| 分支 | 生命期 | 说明 |
|
||
|---|---|---|
|
||
| `main` | 永久 | 稳定版本，受保护 |
|
||
| `develop` | 永久 | 日常开发分支，所有 agent 共用 |
|
||
|
||
**辅助分支（可选，用于实验）：**
|
||
|
||
| 分支 | 前缀 | 生命期 | 说明 |
|
||
|---|---|---|---|
|
||
| 原型 | `prototype/` | 实验完即删 | 技术验证，随便写 |
|
||
| 发布 | `release/` | 永久 | 从 main 切出，版本标记 |
|
||
|
||
**流程：**
|
||
1. 所有开发在 `develop` 上进行 → 2. 迭代完成时创建 PR → 3. 审查通过后合并回 `main`
|
||
|
||
---
|
||
|
||
## 提交规范
|
||
|
||
**格式：** `<type>(<scope>): <中文描述>`
|
||
|
||
- subject ≤ 50 字符，中文描述，技术术语保留英文
|
||
- body 可选，每行 ≤ 72 字符
|
||
|
||
**Type（必选）：**
|
||
|
||
| Type | 用途 |
|
||
|---|---|
|
||
| `feat` | 新功能 |
|
||
| `fix` | Bug 修复 |
|
||
| `art` | 美术资源 |
|
||
| `level` | 关卡/场景 |
|
||
| `audio` | 音效/音乐 |
|
||
| `bp` | 蓝图逻辑 |
|
||
| `refactor` | 重构（不改功能） |
|
||
| `config` | 项目/引擎配置 |
|
||
| `docs` | 文档 |
|
||
| `wip` | 进行中（未完成） |
|
||
|
||
**Scope（可选，常用）：**
|
||
`player` `enemy` `combat` `ui` `camera` `inventory` `dialogue` `quest` `save` `audio` `animation` `ai` `level` `vfx`
|
||
|
||
**示例：**
|
||
```
|
||
feat(player): 实现角色跳跃和二段跳
|
||
fix(camera): 修复穿墙时摄像机卡顿问题
|
||
bp(enemy): 实现巡逻-追击-攻击状态机
|
||
wip(crafting): 合成系统UI初步框架
|
||
config: 启用Nanite和Lumen
|
||
```
|
||
|
||
---
|
||
|
||
## UE5 注意事项
|
||
|
||
- 蓝图与 C++ 分开提交
|
||
- `.uasset` / `.umap` 无法 diff → commit message 必须写清改了什么
|
||
- 不提交 `Binaries/` `Intermediate/` `Saved/` `.vs/`
|
||
|
||
---
|
||
|
||
## 版本号
|
||
|
||
`v主版本.次版本.修订号` — 主版本=里程碑，次版本=新系统，修订号=小修
|
||
|
||
---
|
||
|
||
## 远程仓库
|
||
|
||
**SSH 地址**：`ssh://sc-gitea@micecola.top:2223/starmen1265/ChildHood.git`
|
||
|
||
> ⚠️ 用户名是 `sc-gitea`（非默认 `git`），端口是 `2223`（非默认 22）
|
||
|
||
**切换远程地址**：
|
||
```bash
|
||
git remote set-url origin ssh://sc-gitea@micecola.top:2223/starmen1265/ChildHood.git
|
||
```
|
||
|
||
**SSH config**（`~/.ssh/config`）：
|
||
```
|
||
Host gitea micecola.top
|
||
HostName micecola.top
|
||
Port 2223
|
||
User sc-gitea
|
||
IdentityFile ~/.ssh/id_ed25519_gitea
|
||
IdentitiesOnly yes
|
||
```
|
||
|
||
**内网地址**（家里用）：`ssh://sc-gitea@192.168.1.22:2223/starmen1265/ChildHood.git`
|
||
|
||
完整规范见 → [GIT-GUIDE.md](GIT-GUIDE.md)
|
||
|
||
---
|
||
|
||
## 自动化工作流
|
||
|
||
`git-workflow.sh` 脚本封装了常用 git 操作：
|
||
|
||
```bash
|
||
# 开始工作：确保在 develop 上且最新
|
||
bash .claude/scripts/git-workflow.sh ready
|
||
|
||
# 提交修改
|
||
bash .claude/scripts/git-workflow.sh commit <type> <scope> "中文描述"
|
||
|
||
# 推送到远程
|
||
bash .claude/scripts/git-workflow.sh push
|
||
|
||
# 查看状态
|
||
bash .claude/scripts/git-workflow.sh status
|
||
```
|
||
|
||
### PM 发布流程
|
||
|
||
```bash
|
||
# 创建 develop → main PR
|
||
bash .claude/scripts/git-workflow.sh release "迭代名称"
|
||
|
||
# 用户在 Gitea 合并后同步
|
||
bash .claude/scripts/git-workflow.sh post-release
|
||
```
|