# Git 提交准备清单

> **创建时间：** 2025-11-15  
> **目的：** 整理未被 Git 管理的文件，准备提交到远程仓库

---

## 📊 未追踪文件统计

| 类别 | 数量 | 操作建议 |
|------|------|----------|
| **✅ 应该提交的文件** | ~350 个 | 需要添加 |
| **⚠️ 需要确认的文件** | ~30 个 | 人工判断 |
| **❌ 不应提交的文件** | ~20 个 | 忽略或删除 |

---

## ✅ 第一类：应该提交的文件（高优先级）

### 1. 配置文件（2 个）⭐
```
.editorconfig           ← 编辑器统一配置（UTF-8）
.gitattributes          ← Git 行尾配置
```
**理由**：防止中文乱码，统一团队开发规范

### 2. 后端核心代码（~60 个文件）⭐⭐⭐
```
backend/src/common/            ← 通用能力层（新架构）
├── document/ExtractionClient.ts
├── llm/adapters/
│   ├── DeepSeekAdapter.ts
│   ├── QwenAdapter.ts
│   ├── LLMFactory.ts
│   └── types.ts
├── middleware/validateProject.ts
├── rag/DifyClient.ts
└── utils/jsonParser.ts

backend/src/legacy/            ← 业务代码（新架构）
├── controllers/  (8 个文件)
├── routes/       (7 个文件)
├── services/     (8 个文件)
└── templates/    (1 个文件)
```
**理由**：Task 19 后端架构重构的核心成果

### 3. 前端新架构（frontend-v2，~30 个文件）⭐⭐⭐
```
frontend-v2/                   ← 新前端架构（React 19）
├── package.json
├── src/framework/             ← 模块注册、权限、路由
│   ├── modules/               ← 模块注册机制
│   ├── permission/            ← 权限管理
│   └── router/                ← 路由守卫
├── src/modules/               ← 6 个业务模块占位符
│   ├── aia/
│   ├── asl/
│   ├── pkb/
│   ├── dc/
│   ├── ssa/
│   └── st/
└── src/pages/HomePage.tsx
```
**理由**：Task 17 前端模块注册机制的成果

### 4. 前端扩展功能（~40 个文件）⭐⭐
```
frontend/src/api/
├── batchApi.ts               ← 批量处理 API
└── reviewApi.ts              ← 稿件审查 API

frontend/src/components/chat/
├── BatchMode.tsx             ← 批量处理模式
├── DeepReadMode.tsx          ← 深度阅读模式
├── FullTextMode.tsx          ← 全文模式
├── DocumentSelector.tsx      ← 文档选择器
└── ...（共 20+ 个组件）

frontend/src/components/review/
├── EditorialReview.tsx       ← 编辑规范评估
├── MethodologyReview.tsx     ← 方法学评估
└── ScoreCard.tsx

frontend/src/pages/
├── ReviewPage.tsx            ← 稿件审查页面
├── ChatPage.backup.tsx       ← 备份文件（可删除）
└── ChatPage.new.tsx          ← 备份文件（可删除）
```
**理由**：Phase 2-3 的重要功能扩展

### 5. 文档体系（~250 个文件）⭐⭐⭐
```
docs/00-系统总体设计/         ← 系统架构文档（12 个文件）
docs/00-项目概述/             ← PRD 和白皮书（6 个文件）
docs/01-平台基础层/           ← 平台层文档（10 个文件）
docs/02-通用能力层/           ← 通用能力文档（9 个文件）
docs/03-业务模块/             ← 业务模块文档（~150 个文件）
├── ASL-AI智能文献/           ← 新增的 ASL 模块文档 ⭐
│   ├── 01-需求分析/
│   ├── 02-技术设计/
│   │   ├── 06-质量保障与可追溯策略.md
│   │   └── 07-文献处理技术选型.md
│   ├── 03-UI设计/
│   ├── 04-开发计划/
│   └── 05-测试文档/
│       └── 03-测试数据/
│           ├── README.md
│           ├── Test Cases.xlsx
│           └── 测试案例的PICOS、纳入标准、排除标准.txt
docs/04-开发规范/             ← 开发规范（6 个文件）
docs/05-部署文档/             ← 部署文档（2 个文件）
docs/06-测试文档/
docs/07-运维文档/             ← 运维文档（3 个文件）
docs/08-项目管理/             ← 项目管理文档（14 个文件）
docs/09-架构实施/             ← 架构实施文档（21 个文件）
docs/_templates/              ← 文档模板（5 个文件）
```
**理由**：完整的文档体系，团队协作必需

### 6. 后端配置和脚本（~15 个文件）
```
backend/CLOSEAI-CONFIG.md
backend/check-api-config.js
backend/database-validation-simple.sql
backend/database-validation.sql
backend/prisma/migrations/20251012124747_add_batch_processing_module/
backend/prisma/migrations/20251014120128_add_review_tasks/
backend/prisma/seed.ts
backend/prompts/
├── review_editorial_system.txt
└── review_methodology_system.txt
backend/update-env-closeai.ps1
backend/初始化测试用户.bat
backend/测试用户说明.md
```
**理由**：数据库迁移、配置脚本、提示词模板

### 7. 项目根目录文档（~15 个文件）
```
START-HERE-FOR-AI.md           ← AI 上手指南
PHASE1-测试指南.md
Phase2-UI优化总结.md
Phase2-全文阅读模式-真实实现.md
Phase2-快速测试清单.md
Phase2-测试指南.md
Phase3-快速参考.md
Phase3-最终收尾-测试指南.md
README-Phase2测试.md
README-里程碑1.5完成.md
如何测试Phase2.md
智能引用功能-测试指南.md
检查测试环境.bat
稿件审查功能-最终完成报告.md
测试记录/
```
**理由**：阶段性成果总结和测试指南

---

## ⚠️ 第二类：需要确认的文件

### 1. 测试脚本（可选）
```
backend/test-batch-api.js      ← 批量处理测试
backend/test-review-api.js     ← 审查 API 测试
backend/temp-migration/        ← 临时迁移脚本
```
**建议**：如果还需要，可以提交；如果是一次性测试，可以删除

### 2. 前端备份文件
```
frontend/src/pages/ChatPage.backup.tsx
frontend/src/pages/ChatPage.new.tsx
```
**建议**：**删除**（已有正式的 `ChatPage.tsx`）

### 3. Phase 测试文档（根目录）
```
PHASE1-测试指南.md
Phase2-*.md
Phase3-*.md
README-Phase2测试.md
```
**建议**：考虑是否移到 `docs/06-测试文档/` 或 `docs/08-项目管理/`，然后提交

---

## ❌ 第三类：不应提交的文件（应该被忽略）

### 1. 乱码文件夹（手动删除）❌
```
docs/03-涓氬姟妯″潡/       ← 已确认是 "03-业务模块" 的乱码版本
```
**操作**：**手动删除**（您已确认）

### 2. 停止服务脚本（根目录）
```
stop-all-services.bat         ← 重复文件（已有正式版本）
```
**建议**：检查是否与其他启动脚本重复，如重复则删除

---

## 🎯 提交策略建议

### 方案 A：一次性全部提交（快速但风险较高）

```bash
# 添加所有应该提交的文件
git add .editorconfig .gitattributes
git add backend/src/common/ backend/src/legacy/
git add backend/prisma/migrations/ backend/prisma/seed.ts
git add backend/prompts/ backend/CLOSEAI-CONFIG.md
git add frontend-v2/
git add frontend/src/api/batchApi.ts frontend/src/api/reviewApi.ts
git add frontend/src/components/chat/ frontend/src/components/review/
git add frontend/src/pages/ReviewPage.tsx
git add "docs/00-系统总体设计/" "docs/03-业务模块/"
git add START-HERE-FOR-AI.md

# 一次性提交
git commit -m "feat: 提交 Week 2 完整成果

- ✅ 后端架构重构（legacy + common 分层）
- ✅ 前端模块注册机制（frontend-v2）
- ✅ 批量处理和稿件审查功能
- ✅ 完整文档体系（250+ 文档）
- ✅ ASL 模块设计文档
- ✅ 编码规范配置（.editorconfig, .gitattributes）
"
```

### 方案 B：分批提交（推荐，更清晰）⭐

#### 批次 1：配置文件和编码规范
```bash
git add .editorconfig .gitattributes
git commit -m "chore: 添加编码规范配置，防止中文乱码"
```

#### 批次 2：后端架构重构
```bash
git add backend/src/common/ backend/src/legacy/
git add backend/prisma/schema.prisma backend/src/index.ts
git commit -m "refactor(backend): 后端架构增量演进（Task 19）

- 新增 common/ 通用能力层
- 新增 legacy/ 业务代码层
- 更新 index.ts 路由注册
- 保持系统正常运行"
```

#### 批次 3：数据库迁移和配置
```bash
git add backend/prisma/migrations/
git add backend/prisma/seed.ts
git add backend/prompts/
git add backend/CLOSEAI-CONFIG.md
git commit -m "feat(backend): 添加批量处理和稿件审查模块

- Prisma 迁移：批量处理表
- Prisma 迁移：稿件审查表
- 新增提示词模板
- CloseAI 配置文档"
```

#### 批次 4：前端新架构（frontend-v2）
```bash
git add frontend-v2/
git commit -m "feat(frontend): 新增 frontend-v2 模块化架构（Task 17）

- React 19 + TypeScript + Vite
- 模块注册机制
- 权限管理系统
- 路由守卫
- 6 个业务模块占位符（AIA/ASL/PKB/DC/SSA/ST）"
```

#### 批次 5：前端功能扩展
```bash
git add frontend/src/api/batchApi.ts
git add frontend/src/api/reviewApi.ts
git add frontend/src/components/chat/
git add frontend/src/components/review/
git add frontend/src/pages/ReviewPage.tsx
git add frontend/src/hooks/
git add frontend/src/types/chat.ts
git commit -m "feat(frontend): 添加批量处理和稿件审查功能

- 批量处理模式（BatchMode）
- 深度阅读模式（DeepReadMode）
- 全文模式（FullTextMode）
- 稿件审查页面（ReviewPage）
- 文档选择器组件"
```

#### 批次 6：文档体系
```bash
git add "docs/00-系统总体设计/"
git add "docs/00-项目概述/"
git add "docs/01-平台基础层/"
git add "docs/02-通用能力层/"
git add "docs/03-业务模块/"
git add "docs/04-开发规范/"
git add "docs/05-部署文档/"
git add "docs/06-测试文档/"
git add "docs/07-运维文档/"
git add "docs/08-项目管理/"
git add "docs/09-架构实施/"
git add "docs/_templates/"
git commit -m "docs: 完善文档体系（250+ 文档）

- 系统总体设计（12 个文档）
- 业务模块文档（ASL/AIA/PKB/RVW 等）
- ASL 模块完整设计（质量保障策略、技术选型）
- 架构实施报告
- 项目管理文档
- 开发规范和模板"
```

#### 批次 7：测试和指南文档
```bash
git add START-HERE-FOR-AI.md
git add PHASE1-测试指南.md
git add Phase2*.md Phase3*.md
git add README-*.md
git add 如何测试Phase2.md
git add 智能引用功能-测试指南.md
git add 检查测试环境.bat
git add 稿件审查功能-最终完成报告.md
git add 测试记录/
git commit -m "docs: 添加测试指南和阶段性总结文档

- AI 快速上手指南
- Phase 1-3 测试指南和总结
- 功能测试文档
- 检查脚本"
```

#### 批次 8：清理和最终检查
```bash
# 删除备份文件
git rm frontend/src/pages/ChatPage.backup.tsx
git rm frontend/src/pages/ChatPage.new.tsx

# 删除临时脚本（如果不需要）
git rm backend/test-batch-api.js
git rm backend/test-review-api.js
git rm -r backend/temp-migration/

git commit -m "chore: 清理备份文件和临时测试脚本"
```

---

## 📋 执行前检查清单

在提交前，请确认：

### ✅ 必做项
- [ ] **删除乱码文件夹**：`docs/03-涓氬姟妯″潡/`
- [ ] **确认 .env 文件未被追踪**（包含敏感信息）
- [ ] **确认 node_modules/ 未被追踪**
- [ ] **确认 venv/ 未被追踪**
- [ ] **后端服务正常运行**
- [ ] **前端服务正常运行**
- [ ] **数据库连接正常**

### ⚠️ 建议项
- [ ] 删除前端备份文件：`ChatPage.backup.tsx`, `ChatPage.new.tsx`
- [ ] 整理根目录测试文档：考虑移到 `docs/` 目录
- [ ] 检查是否有个人配置文件（如 `.vscode/settings.json`）
- [ ] 运行一次完整测试

---

## 🚀 推荐执行步骤

### 步骤 1：清理不需要的文件
```bash
# 1. 手动删除乱码文件夹
删除：D:\MyCursor\AIclinicalresearch\docs\03-涓氬姟妯″潡

# 2. 删除前端备份文件（可选）
cd D:\MyCursor\AIclinicalresearch\frontend\src\pages
del ChatPage.backup.tsx
del ChatPage.new.tsx

# 3. 删除临时测试脚本（可选）
cd D:\MyCursor\AIclinicalresearch\backend
del test-batch-api.js
del test-review-api.js
```

### 步骤 2：验证系统正常运行
```bash
# 启动后端
cd backend
npm run dev

# 启动前端（新窗口）
cd frontend-v2
npm run dev

# 测试几个核心功能
```

### 步骤 3：分批提交（按方案 B 执行）
```bash
# 按照上面"方案 B"的 7 个批次依次执行
# 每个批次提交后，检查 git log 确认无误
```

### 步骤 4：推送到远程仓库
```bash
# 查看所有提交
git log --oneline -10

# 推送到远程
git push origin master
```

---

## 📊 预期结果

提交完成后，远程仓库将包含：

| 项目 | 数量 | 状态 |
|------|------|------|
| **后端代码** | ~60 个文件 | ✅ 新架构 |
| **前端代码（v2）** | ~30 个文件 | ✅ 模块化 |
| **前端扩展功能** | ~40 个文件 | ✅ 批量/审查 |
| **文档** | ~250 个文件 | ✅ 完整体系 |
| **配置文件** | 2 个 | ✅ 编码规范 |
| **数据库迁移** | 2 个 | ✅ 新表结构 |
| **测试数据** | 2 个 | ✅ ASL 测试 |

**总计：约 400 个文件**

---

## ⚠️ 注意事项

1. **不要一次性 `git add .`**  
   - 可能会误提交 `.env`、`node_modules/` 等敏感/大文件

2. **分批提交的好处**  
   - ✅ 提交历史清晰
   - ✅ 易于回滚
   - ✅ 代码审查方便
   - ✅ 便于追踪问题

3. **推送前确认**  
   - 检查是否有敏感信息（API Key、密码）
   - 确认 `.gitignore` 已生效
   - 运行一次完整测试

---

**准备好后，请告诉我您想使用哪种方案（A 或 B），我来帮您执行！** 🚀

