111 lines
3.0 KiB
Markdown
111 lines
3.0 KiB
Markdown
# UnityAI Git 规定指南
|
||
|
||
## 一、提交日志格式规范
|
||
|
||
### 1.1 格式要求
|
||
|
||
所有 Git 提交日志必须遵循以下格式：
|
||
|
||
```
|
||
【操作原因】具体操作内容
|
||
```
|
||
|
||
### 1.2 格式说明
|
||
|
||
| 部分 | 说明 | 示例 |
|
||
|------|------|------|
|
||
| `【操作原因】` | 用中文方括号包裹，描述本次操作的核心目的 | 【初始化】、【更新】、【修复】 |
|
||
| `具体操作内容` | 详细描述本次提交的内容，使用中文 | 上传框架文档、修改配置文件 |
|
||
|
||
### 1.3 操作原因分类
|
||
|
||
| 分类 | 说明 | 适用场景 |
|
||
|------|------|----------|
|
||
| **【初始化】** | 首次创建或上传项目/文档 | 新项目初始化、首次上传文档 |
|
||
| **【更新】** | 修改或完善现有内容 | 更新文档内容、优化代码逻辑 |
|
||
| **【新增】** | 添加新的文件或功能 | 新增文档、新增代码模块 |
|
||
| **【修复】** | 修复错误或问题 | 修复文档错误、修复代码Bug |
|
||
| **【重构】** | 重构代码结构或文档结构 | 优化代码架构、重新组织文档 |
|
||
| **【删除】** | 删除文件或功能 | 删除无用文件、移除废弃代码 |
|
||
| **【迁移】** | 迁移文件或项目 | 文件位置调整、项目迁移 |
|
||
| **【配置】** | 修改配置文件 | 更新配置、调整参数 |
|
||
|
||
---
|
||
|
||
## 二、提交日志示例
|
||
|
||
### 2.1 文档相关
|
||
|
||
```
|
||
【初始化】上传UnityAI框架文档，包含StrayFog框架架构分析、业务开发指南、核心库保护规范
|
||
【更新】完善StrayFog框架架构分析中Core层的描述
|
||
【新增】添加Git规定指南文档
|
||
【修复】修正业务开发指南中的代码示例错误
|
||
```
|
||
|
||
### 2.2 代码相关
|
||
|
||
```
|
||
【新增】实现AI决策系统核心模块
|
||
【更新】优化对象池性能
|
||
【修复】修复事件系统内存泄漏问题
|
||
【重构】重构技能系统架构
|
||
【删除】移除废弃的测试代码
|
||
```
|
||
|
||
### 2.3 配置相关
|
||
|
||
```
|
||
【配置】更新构建脚本参数
|
||
【配置】调整日志输出级别
|
||
```
|
||
|
||
---
|
||
|
||
## 三、Git 工作流程
|
||
|
||
### 3.1 提交流程
|
||
|
||
```
|
||
修改文件
|
||
│
|
||
▼
|
||
git add . # 暂存所有修改
|
||
│
|
||
▼
|
||
git commit -m "【操作原因】具体操作内容" # 提交并撰写规范日志
|
||
│
|
||
▼
|
||
git push # 推送到远程仓库
|
||
```
|
||
|
||
### 3.2 分支管理
|
||
|
||
| 分支名称 | 用途 |
|
||
|----------|------|
|
||
| `master` | 主分支，稳定版本 |
|
||
| `develop` | 开发分支，日常开发 |
|
||
| `feature/*` | 功能分支，开发新功能 |
|
||
| `bugfix/*` | Bug修复分支 |
|
||
|
||
### 3.3 远程仓库信息
|
||
|
||
- **仓库地址**: `https://jinmt.com/Shiliang/UnityAI.git`
|
||
- **用户名**: `Shiliang`
|
||
- **密码**: `Sl940104`
|
||
|
||
---
|
||
|
||
## 四、注意事项
|
||
|
||
1. **日志语言**: 统一使用中文描述
|
||
2. **简洁明了**: 日志应简洁清晰，准确反映提交内容
|
||
3. **分类准确**: 选择合适的操作原因分类
|
||
4. **避免空提交**: 禁止无内容的空提交
|
||
5. **定期推送**: 开发完成后及时推送到远程仓库
|
||
|
||
---
|
||
|
||
**版本**: v1.0
|
||
**生效日期**: 2026年5月22日
|
||
**适用范围**: UnityAI项目团队 |