sanguo_quant_live/GITEE_MANAGEMENT.md

# 📦 Gitee仓库管理规范

## 🎯 管理原则

### **所有成果物统一管理**
- 所有代码、文档、数据、配置必须提交到Gitee仓库
- 禁止在本地保留未提交的成果物
- 每日工作结束前必须提交当日成果

### **仓库地址**
- **主仓库**：`git@gitee.com:cfdaily/sanguo_quant_live.git`
- **备份仓库**：（根据需要设置）

## 📁 仓库目录结构规范

### **根目录结构**
```
sanguo_quant_live/
├── README.md                    # 项目总览
├── GITEE_MANAGEMENT.md         # 仓库管理规范（本文档）
├── management/                  # 诸葛亮 - 项目管理
├── quality/                     # 司马懿 - 质量保障
├── platform/                    # 姜维 - 平台开发
├── value-investing/             # 庞统 - 价值投资
├── technical-strategy/          # 张飞 - 技术策略
├── risk-management/             # 关羽 - 风险管理
├── data-engineering/            # 赵云 - 数据工程
└── knowledge-base/              # 共享知识库
```

### **各领域目录结构要求**
每个领域必须遵循统一结构：
```
[领域名称]/
├── README.md                    # 领域工作说明
├── research/                    # 研究文档
│   ├── [研究主题1]/            # 具体研究主题
│   └── [研究主题2]/
├── code/                        # 代码文件
│   ├── src/                     # 源代码
│   ├── tests/                   # 测试代码
│   └── scripts/                 # 脚本文件
├── data/                        # 数据文件（小文件）
│   ├── raw/                     # 原始数据
│   ├── processed/               # 处理后的数据
│   └── metadata/                # 数据元数据
├── results/                     # 结果文件
│   ├── backtest/                # 回测结果
│   ├── analysis/                # 分析结果
│   └── reports/                 # 报告文件
└── docs/                        # 文档文件
    ├── design/                  # 设计文档
    ├── api/                     # API文档
    └── user-guide/              # 使用指南
```

## 🔄 Git工作流程

### **分支策略**
1. **main分支**：稳定版本，仅接受合并请求
2. **develop分支**：开发集成分支
3. **feature/[功能名]**：功能开发分支
4. **bugfix/[bug名]**：bug修复分支
5. **release/[版本号]**：发布分支

### **提交规范**
```
[类型]: [简要描述]

[详细描述（可选）]

[关联issue（可选）]
```

**类型说明**：
- `feat`: 新功能
- `fix`: bug修复
- `docs`: 文档更新
- `style`: 代码格式调整
- `refactor`: 代码重构
- `test`: 测试相关
- `chore`: 构建过程或辅助工具变动

**示例**：
```
feat: 添加低估值选股策略

- 实现P/E、P/B多因子筛选
- 添加回测验证模块
- 更新策略文档

关联 #123
```

### **合并请求流程**
1. 从develop分支创建feature分支
2. 在feature分支上开发
3. 完成开发后，创建合并请求到develop
4. 经过代码评审后合并
5. 定期将develop合并到main

## 📊 代码管理规范

### **代码质量要求**
1. ✅ 代码必须通过所有测试
2. ✅ 代码必须符合编码规范
3. ✅ 必须有充分的注释
4. ✅ 必须有单元测试覆盖
5. ✅ 必须通过代码评审

### **文档要求**
1. ✅ 每个模块必须有README
2. ✅ 每个函数必须有文档字符串
3. ✅ 每个API必须有使用示例
4. ✅ 每个配置项必须有说明

### **数据管理**
1. **大文件**：使用Git LFS管理
2. **敏感数据**：不提交到仓库，使用配置模板
3. **临时数据**：不提交到仓库
4. **数据版本**：重要数据必须有版本管理

## 🚀 日常操作指南

### **第一天：克隆仓库**
```bash
# 克隆仓库
git clone git@gitee.com:cfdaily/sanguo_quant_live.git

# 进入项目目录
cd sanguo_quant_live

# 设置用户信息
git config user.name "你的名字"
git config user.email "你的邮箱"
```

### **日常开发流程**
```bash
# 1. 更新本地代码
git checkout develop
git pull origin develop

# 2. 创建功能分支
git checkout -b feature/your-feature-name

# 3. 开发工作
# ... 编写代码，添加文件 ...

# 4. 提交更改
git add .
git commit -m "feat: 你的功能描述"

# 5. 推送到远程
git push origin feature/your-feature-name

# 6. 创建合并请求
# 在Gitee网站上创建合并请求到develop分支
```

### **提交前检查清单**
- [ ] 代码通过所有测试
- [ ] 符合编码规范
- [ ] 有充分的注释
- [ ] 更新了相关文档
- [ ] 提交信息规范
- [ ] 没有提交敏感信息

## 📋 各领域提交要求

### **诸葛亮（项目管理）**
- 项目计划更新
- 进度报告
- 会议记录
- 协调文档

### **司马懿（质量保障）**
- 质量标准文档
- 测试用例
- 审计报告
- 质量评分

### **姜维（平台开发）**
- 平台代码
- 部署脚本
- 配置模板
- 监控配置

### **庞统（价值投资）**
- 基本面研究文档
- 价值策略代码
- 回测结果
- 研究报告

### **张飞（技术策略）**
- 技术分析文档
- 算法策略代码
- 性能测试结果
- 技术报告

### **关羽（风险管理）**
- 风险模型文档
- 风控系统代码
- 风险测试结果
- 风控方案

### **赵云（数据工程）**
- 数据管道代码
- 数据质量报告
- 数据API文档
- 数据治理规范

## 🛡️ 安全规范

### **禁止提交的内容**
1. ❌ API密钥、密码、令牌
2. ❌ 个人隐私信息
3. ❌ 商业机密数据
4. ❌ 未授权第三方代码

### **敏感信息处理**
1. 使用环境变量
2. 使用配置文件模板
3. 使用密钥管理服务
4. 在.gitignore中排除敏感文件

### **.gitignore配置**
必须包含：
```
# 敏感信息
*.key
*.pem
*.p12
*.keystore
.env
config.local.*

# 临时文件
*.log
*.tmp
*.cache

# 开发环境
.idea/
.vscode/
*.swp
*.swo

# 数据文件（大文件）
data/raw/
data/processed/
*.csv
*.parquet
*.feather
```

## 📈 仓库维护

### **每日维护**
1. 提交当日工作成果
2. 更新进度文档
3. 解决合并冲突
4. 同步最新代码

### **每周维护**
1. 清理临时分支
2. 更新项目文档
3. 备份重要数据
4. 检查仓库健康度

### **每月维护**
1. 归档历史版本
2. 优化仓库大小
3. 更新依赖版本
4. 安全审计

## 🎯 立即行动

### **第1天任务**
1. ✅ 阅读本规范
2. ✅ 克隆仓库到本地
3. ✅ 设置Git用户信息
4. ✅ 创建个人工作目录
5. ✅ 提交第一次工作成果

### **各领域第1周提交要求**
1. ✅ 个人工作目录结构
2. ✅ 知识库初始内容
3. ✅ 第1周工作计划
4. ✅ 环境配置文档

---

**统一管理，协同开发，共创辉煌！**

**所有成果物必须提交到Gitee仓库！** 📦