【重构】整理文档目录结构,创建5个分类文件夹,拆分业务开发指南为8个独立文档,添加README入口导航

This commit is contained in:
Shiliang
2026-05-22 10:41:34 +08:00
parent 4139f8d392
commit e4198ddd16
13 changed files with 710 additions and 567 deletions

View File

@@ -0,0 +1,111 @@
# 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项目团队

View File

@@ -0,0 +1,80 @@
# StrayFog 框架核心库保护规范
## 一、核心库定义
### 1.1 核心库范围(只读)
| 路径 | 说明 |
|------|------|
| `Assets/StrayFog/Core` | 基础框架核心 |
| `Assets/Game/GameHFScripte/CopyToHF` | 游戏核心业务框架 |
| `Assets/Game/GameGeneralScripte` | 通用工具层 |
---
## 二、保护规则
### 2.1 访问方式
**业务代码必须通过 `HFFunCatalogue` 统一入口访问核心库:**
```csharp
// ✅ 正确:通过统一入口访问
HFFunCatalogue.UIManager.OpenWindow<LoginWindow>();
HFFunCatalogue.Asset.LoadAsset<GameObject>("path");
HFFunCatalogue.Scene.LoadScene("MainScene");
// ❌ 禁止:直接访问核心库
HFUIWindowMgr.Instance.OpenWindow<LoginWindow>(); // 禁止
HFABMgr.Instance.LoadAsset<GameObject>("path"); // 禁止
```
### 2.2 禁止操作
| 禁止行为 | 后果 |
|---------|------|
| 修改核心库源代码 | 破坏框架稳定性 |
| 删除/重命名核心库文件 | 编译错误 |
| 直接实例化核心库内部类 | 违反封装原则 |
| 绕过 `HFFunCatalogue` 直接调用核心库单例 | 难以维护和测试 |
---
## 三、修改流程
```
业务人员发现问题/需求
提交Issue到框架团队
框架团队评估需求
┌────┴────┐
│ │
合理 不合理
│ │
▼ ▼
开发修复 反馈拒绝
代码审查 → 发布新版本 → 业务团队更新引用
```
---
## 四、违规处理
| 等级 | 违规行为 | 处理方式 |
|-----|---------|---------|
| **轻微** | 误修改注释、空行 | 警告+恢复 |
| **一般** | 修改非核心逻辑 | 通报批评+代码回滚 |
| **严重** | 修改核心逻辑导致Bug | 绩效扣分+修复责任 |
| **重大** | 删除核心文件导致崩溃 | 追责+修复责任 |
---
**版本**: v1.0
**生效日期**: 2024年
**适用范围**: OnlineGame项目