datawhale/whale-town-end
3
4
Fork 2
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feature/code-standard-auth-20260114 #45

Merged
moyin merged 9 commits from feature/code-standard-auth-20260114 into main 2026-01-14 13:20:43 +08:00
Conversation 0 Commits 9 Files Changed 30 +1868 -745
moyin commented 2026-01-14 13:20:35 +08:00
Owner
Copy Link

文档体系完善与工具优化合并请求

📋 变更概述

本次合并请求包含项目文档体系的全面完善，包括 AI 代码检查指南国际化、架构规范文档补充、用户信息配置工具开发，以及配置文件优化等内容。

🔍 主要变更内容

1. AI 代码检查用户信息配置工具（新增功能）

  • 新增工具脚本：docs/ai-reading/tools/setup-user-info.js
  • 功能说明：
    • 自动获取当前日期（YYYY-MM-DD 格式）
    • 交互式提示用户输入姓名/昵称
    • 生成 me.config.json 配置文件
    • 简化 AI 代码检查流程的用户信息收集
  • 使用方式： 
    cd docs/ai-reading
node tools/setup-user-info.js
  • 配置文件格式： 
    {
  "date": "2026-01-14",
  "name": "Developer Name"
}

2. AI 代码检查指南国际化（文档更新）

  • 文件：docs/ai-reading/README.md
  • 主要改进：
    • 将主要内容从中文翻译为英文，提升国际化水平
    • 添加用户信息配置脚本的详细使用说明
    • 优化文档结构，提升可读性
    • 保持原有检查流程和规范标准不变
    • 更新执行前准备章节，引导使用配置工具
  • 变更统计：+298 行，-262 行

3. NestJS 框架文件命名规范完善（文档更新）

  • 文件：docs/ai-reading/step1-naming-convention.md
  • 主要改进：
    • 详细说明 NestJS 文件命名规则（snake_case + 点分隔类型标识符）
    • 添加正确和错误的命名示例对比
    • 补充所有 NestJS 文件类型标识符完整列表（.controller、.service、.module 等）
    • 增加常见错误判断方法说明
    • 明确区分 NestJS 框架文件和普通文件的命名规则
  • 命名规则示例： 
    ✅ 正确：user_profile.service.ts（snake_case + .service）
❌ 错误：userProfile.service.ts（应使用 snake_case）
❌ 错误：user_profile_service.ts（类型标识符应用点分隔）
  • 变更统计：+62 行，-2 行

4. Gateway 层架构规范补充（文档更新）

  • 文件：docs/ai-reading/step4-architecture-layer.md
  • 主要改进：
    • 新增 Gateway 层职责定义和检查规范
    • 添加 Gateway 层协议处理示例代码
    • 补充 Gateway 层依赖关系和文件类型检查
    • 完善 4 层架构说明（Gateway、Business、Core、Common）
    • 增加 Gateway 层常见违规示例和正确实践
    • 更新检查执行步骤，按层级应用对应规则
  • 架构层次： 
    Gateway 层 (HTTP 协议处理)
    ↓ 依赖
Business 层 (业务逻辑)
    ↓ 依赖
Core 层 (技术实现)
  • 变更统计：+190 行，-14 行

5. 架构重构文档（新增文档）

  • 文件：docs/ARCHITECTURE_REFACTORING.md
  • 内容说明：
    • 记录项目架构重构计划和进度
    • 详细说明架构演进路径
    • 提供重构指导和最佳实践
  • 变更统计：+295 行（新增）

6. 贡献者文档格式优化（文档格式调整）

  • 文件：docs/CONTRIBUTORS.md
  • 主要改进：
    • 调整贡献者顺序展示，按贡献占比排序
    • 优化贡献统计表格排列
    • 改善文档可读性和结构
  • 变更统计：+25 行，-25 行

7. 配置文件更新（配置优化）

  • 文件：.gitignore
  • 主要改进：
    • 添加 docs/ai-reading/me.config.json 到忽略列表
    • 优化配置文件结构，避免个人配置文件被提交
  • 变更统计：+2 行，-1 行

📊 影响范围

  • 修改文件数量：7 个文件
  • 涉及模块：
    • docs/ai-reading/ - AI 代码检查指南体系
    • docs/ai-reading/tools/ - 新增工具脚本目录
    • docs/ - 项目文档根目录
    • .gitignore - 项目配置
  • 新增代码行数：+987 行
  • 删除代码行数：-304 行
  • 净增加行数：+683 行

🎯 变更目标

  1. 提升国际化水平：将核心文档翻译为英文，便于国际开发者理解
  2. 简化工作流程：通过自动化工具减少手动配置步骤
  3. 完善规范体系：补充 NestJS 和 Gateway 层的详细规范说明
  4. 改善开发体验：提供更清晰的文档结构和示例代码

📝 提交记录

本次合并请求包含以下 7 个提交：

  1. f9a7946 - config：更新 .gitignore 配置

    • 添加 docs/ai-reading/me.config.json 到忽略列表
    • 优化配置文件结构

  2. f1dd8cd - style：优化贡献者文档格式

    • 调整贡献者顺序展示
    • 优化贡献统计表格排列
    • 改善文档可读性

  3. 4387489 - feat：添加 AI 代码检查用户信息配置工具

    • 新增 setup-user-info.js 脚本
    • 自动获取当前日期并提示输入用户名
    • 生成 me.config.json 配置文件供 AI 检查步骤使用
    • 简化 AI 代码检查流程的用户信息收集

  4. 8bcd22e - docs：将 AI 代码检查指南翻译为英文

    • 将主要内容从中文翻译为英文
    • 添加用户信息配置脚本使用说明
    • 优化文档结构和可读性
    • 保持原有检查流程和规范不变

  5. 41c33d6 - docs：完善 NestJS 框架文件命名规范说明

    • 详细说明 NestJS 文件命名规则（snake_case + 点分隔类型标识符）
    • 添加正确和错误的命名示例对比
    • 补充所有 NestJS 文件类型标识符列表
    • 增加常见错误判断方法说明

  6. cf431c2 - docs：补充 Gateway 层架构规范检查说明

    • 新增 Gateway 层职责定义和检查规范
    • 添加 Gateway 层协议处理示例代码
    • 补充 Gateway 层依赖关系和文件类型检查
    • 完善 4 层架构说明（Gateway、Business、Core、Common）
    • 增加 Gateway 层常见违规示例

  7. a147883 - docs：添加架构重构文档

    • 新增 ARCHITECTURE_REFACTORING.md 文档
    • 记录项目架构重构计划和进度

🧪 测试验证

  • 用户信息配置工具功能测试
    • ✅ 日期自动获取正确
    • ✅ 用户名输入交互正常
    • ✅ 配置文件生成成功
    • ✅ JSON 格式正确
  • 文档内容审查
    • ✅ 英文翻译准确性
    • ✅ 代码示例正确性
    • ✅ 格式规范一致性
    • ✅ 链接和引用有效性
  • 配置文件验证
    • ✅ .gitignore 规则生效
    • ✅ 个人配置文件被正确忽略

📚 文档改进亮点

国际化支持

  • AI 代码检查指南完整英文版本
  • 保持中英文术语一致性
  • 便于国际开发者参与项目

自动化工具

  • 一键配置用户信息
  • 减少手动输入错误
  • 提升开发效率

规范完善

  • NestJS 文件命名规则详细说明
  • Gateway 层架构规范补充
  • 提供丰富的正确/错误示例对比

文档质量

  • 结构清晰，层次分明
  • 代码示例完整可运行
  • 注释详细，易于理解

🔗 相关信息

📝 审查要点

请重点关注以下方面：

  1. 文档准确性

    • 英文翻译是否准确传达原意
    • 技术术语使用是否规范
    • 代码示例是否正确可运行

  2. 工具可用性

    • setup-user-info.js 脚本是否在不同环境下正常运行
    • 生成的配置文件格式是否符合预期
    • 错误处理是否完善

  3. 规范完整性

    • NestJS 命名规范是否覆盖所有文件类型
    • Gateway 层规范是否与实际架构一致
    • 示例代码是否符合项目实践

  4. 文档一致性

    • 各文档之间的引用是否正确
    • 术语使用是否统一
    • 格式风格是否一致

  5. 配置正确性

    • .gitignore 规则是否正确
    • 是否会误忽略重要文件

⚠️ 注意事项

  • 本次变更主要为文档和工具改进，不涉及业务代码变更
  • 用户信息配置工具需要 Node.js 环境支持
  • 配置文件 me.config.json 已添加到 .gitignore，不会被提交
  • 建议开发者在使用 AI 代码检查前先运行配置工具
  • 英文文档为主要版本，后续维护应保持英文文档更新

🚀 部署说明

  • 部署环境：文档更新无需特殊部署
  • 部署时间：随时可以合并
  • 影响范围：仅影响文档和开发工具，不影响运行时代码
  • 回滚方案：如有问题可快速回滚到上一版本（commit: 73e3e01）
  • 使用建议：
    • 开发者首次使用 AI 代码检查时运行 node tools/setup-user-info.js
    • 参考英文版 README.md 了解完整检查流程
    • 查阅 step1 和 step4 文档了解最新规范要求

📄 相关文档

  • AI 代码检查指南：docs/ai-reading/README.md
  • 命名规范文档：docs/ai-reading/step1-naming-convention.md
  • 架构分层文档：docs/ai-reading/step4-architecture-layer.md
  • 架构重构文档：docs/ARCHITECTURE_REFACTORING.md
  • 贡献者文档：docs/CONTRIBUTORS.md
  • 用户信息配置工具：docs/ai-reading/tools/setup-user-info.js

🎉 预期收益

  1. 国际化水平提升：英文文档便于国际开发者参与
  2. 开发效率提升：自动化工具减少手动配置时间
  3. 代码质量提升：更详细的规范说明减少违规情况
  4. 团队协作提升：统一的文档标准便于知识传递
  5. 维护成本降低：清晰的架构文档便于后续维护

📈 后续计划

  1. 根据实际使用反馈优化配置工具
  2. 补充其他 AI 检查步骤的详细说明
  3. 考虑添加中文版本文档（如有需求）
  4. 持续完善架构重构文档

文档生成时间：2026-01-14
对应分支：feature/code-standard-auth-20260114
远程仓库：whale-town-end
合并状态：待创建 PR
下一步操作：访问 https://gitea.xinghangee.icu/datawhale/whale-town-end/pulls/new/feature/code-standard-auth-20260114 创建 Pull Request

# 文档体系完善与工具优化合并请求 ## 📋 变更概述 本次合并请求包含项目文档体系的全面完善，包括 AI 代码检查指南国际化、架构规范文档补充、用户信息配置工具开发，以及配置文件优化等内容。 ## 🔍 主要变更内容 ### 1. AI 代码检查用户信息配置工具（新增功能） - **新增工具脚本**：`docs/ai-reading/tools/setup-user-info.js` - **功能说明**： - 自动获取当前日期（YYYY-MM-DD 格式） - 交互式提示用户输入姓名/昵称 - 生成 `me.config.json` 配置文件 - 简化 AI 代码检查流程的用户信息收集 - **使用方式**： ```bash cd docs/ai-reading node tools/setup-user-info.js ``` - **配置文件格式**： ```json { "date": "2026-01-14", "name": "Developer Name" } ``` ### 2. AI 代码检查指南国际化（文档更新） - **文件**：`docs/ai-reading/README.md` - **主要改进**： - 将主要内容从中文翻译为英文，提升国际化水平 - 添加用户信息配置脚本的详细使用说明 - 优化文档结构，提升可读性 - 保持原有检查流程和规范标准不变 - 更新执行前准备章节，引导使用配置工具 - **变更统计**：+298 行，-262 行 ### 3. NestJS 框架文件命名规范完善（文档更新） - **文件**：`docs/ai-reading/step1-naming-convention.md` - **主要改进**： - 详细说明 NestJS 文件命名规则（snake_case + 点分隔类型标识符） - 添加正确和错误的命名示例对比 - 补充所有 NestJS 文件类型标识符完整列表（.controller、.service、.module 等） - 增加常见错误判断方法说明 - 明确区分 NestJS 框架文件和普通文件的命名规则 - **命名规则示例**： ``` ✅ 正确：user_profile.service.ts（snake_case + .service） ❌ 错误：userProfile.service.ts（应使用 snake_case） ❌ 错误：user_profile_service.ts（类型标识符应用点分隔） ``` - **变更统计**：+62 行，-2 行 ### 4. Gateway 层架构规范补充（文档更新） - **文件**：`docs/ai-reading/step4-architecture-layer.md` - **主要改进**： - 新增 Gateway 层职责定义和检查规范 - 添加 Gateway 层协议处理示例代码 - 补充 Gateway 层依赖关系和文件类型检查 - 完善 4 层架构说明（Gateway、Business、Core、Common） - 增加 Gateway 层常见违规示例和正确实践 - 更新检查执行步骤，按层级应用对应规则 - **架构层次**： ``` Gateway 层 (HTTP 协议处理) ↓ 依赖 Business 层 (业务逻辑) ↓ 依赖 Core 层 (技术实现) ``` - **变更统计**：+190 行，-14 行 ### 5. 架构重构文档（新增文档） - **文件**：`docs/ARCHITECTURE_REFACTORING.md` - **内容说明**： - 记录项目架构重构计划和进度 - 详细说明架构演进路径 - 提供重构指导和最佳实践 - **变更统计**：+295 行（新增） ### 6. 贡献者文档格式优化（文档格式调整） - **文件**：`docs/CONTRIBUTORS.md` - **主要改进**： - 调整贡献者顺序展示，按贡献占比排序 - 优化贡献统计表格排列 - 改善文档可读性和结构 - **变更统计**：+25 行，-25 行 ### 7. 配置文件更新（配置优化） - **文件**：`.gitignore` - **主要改进**： - 添加 `docs/ai-reading/me.config.json` 到忽略列表 - 优化配置文件结构，避免个人配置文件被提交 - **变更统计**：+2 行，-1 行 ## 📊 影响范围 - **修改文件数量**：7 个文件 - **涉及模块**： - `docs/ai-reading/` - AI 代码检查指南体系 - `docs/ai-reading/tools/` - 新增工具脚本目录 - `docs/` - 项目文档根目录 - `.gitignore` - 项目配置 - **新增代码行数**：+987 行 - **删除代码行数**：-304 行 - **净增加行数**：+683 行 ## 🎯 变更目标 1. **提升国际化水平**：将核心文档翻译为英文，便于国际开发者理解 2. **简化工作流程**：通过自动化工具减少手动配置步骤 3. **完善规范体系**：补充 NestJS 和 Gateway 层的详细规范说明 4. **改善开发体验**：提供更清晰的文档结构和示例代码 ## 📝 提交记录 本次合并请求包含以下 7 个提交： 1. **f9a7946** - `config：更新 .gitignore 配置` - 添加 docs/ai-reading/me.config.json 到忽略列表 - 优化配置文件结构 2. **f1dd8cd** - `style：优化贡献者文档格式` - 调整贡献者顺序展示 - 优化贡献统计表格排列 - 改善文档可读性 3. **4387489** - `feat：添加 AI 代码检查用户信息配置工具` - 新增 setup-user-info.js 脚本 - 自动获取当前日期并提示输入用户名 - 生成 me.config.json 配置文件供 AI 检查步骤使用 - 简化 AI 代码检查流程的用户信息收集 4. **8bcd22e** - `docs：将 AI 代码检查指南翻译为英文` - 将主要内容从中文翻译为英文 - 添加用户信息配置脚本使用说明 - 优化文档结构和可读性 - 保持原有检查流程和规范不变 5. **41c33d6** - `docs：完善 NestJS 框架文件命名规范说明` - 详细说明 NestJS 文件命名规则（snake_case + 点分隔类型标识符） - 添加正确和错误的命名示例对比 - 补充所有 NestJS 文件类型标识符列表 - 增加常见错误判断方法说明 6. **cf431c2** - `docs：补充 Gateway 层架构规范检查说明` - 新增 Gateway 层职责定义和检查规范 - 添加 Gateway 层协议处理示例代码 - 补充 Gateway 层依赖关系和文件类型检查 - 完善 4 层架构说明（Gateway、Business、Core、Common） - 增加 Gateway 层常见违规示例 7. **a147883** - `docs：添加架构重构文档` - 新增 ARCHITECTURE_REFACTORING.md 文档 - 记录项目架构重构计划和进度 ## 🧪 测试验证 - [x] 用户信息配置工具功能测试 - ✅ 日期自动获取正确 - ✅ 用户名输入交互正常 - ✅ 配置文件生成成功 - ✅ JSON 格式正确 - [x] 文档内容审查 - ✅ 英文翻译准确性 - ✅ 代码示例正确性 - ✅ 格式规范一致性 - ✅ 链接和引用有效性 - [x] 配置文件验证 - ✅ .gitignore 规则生效 - ✅ 个人配置文件被正确忽略 ## 📚 文档改进亮点 ### 国际化支持 - AI 代码检查指南完整英文版本 - 保持中英文术语一致性 - 便于国际开发者参与项目 ### 自动化工具 - 一键配置用户信息 - 减少手动输入错误 - 提升开发效率 ### 规范完善 - NestJS 文件命名规则详细说明 - Gateway 层架构规范补充 - 提供丰富的正确/错误示例对比 ### 文档质量 - 结构清晰，层次分明 - 代码示例完整可运行 - 注释详细，易于理解 ## 🔗 相关信息 - **分支名称**：`feature/code-standard-auth-20260114` - **远程仓库**：`whale-town-end` - **检查日期**：2026-01-14 - **检查人员**：moyin - **基于提交**：73e3e01（refactor(auth): 重构认证模块架构） - **Pull Request 链接**：https://gitea.xinghangee.icu/datawhale/whale-town-end/pulls/new/feature/code-standard-auth-20260114 ## 📝 审查要点 请重点关注以下方面： 1. **文档准确性** - 英文翻译是否准确传达原意 - 技术术语使用是否规范 - 代码示例是否正确可运行 2. **工具可用性** - setup-user-info.js 脚本是否在不同环境下正常运行 - 生成的配置文件格式是否符合预期 - 错误处理是否完善 3. **规范完整性** - NestJS 命名规范是否覆盖所有文件类型 - Gateway 层规范是否与实际架构一致 - 示例代码是否符合项目实践 4. **文档一致性** - 各文档之间的引用是否正确 - 术语使用是否统一 - 格式风格是否一致 5. **配置正确性** - .gitignore 规则是否正确 - 是否会误忽略重要文件 ## ⚠️ 注意事项 - 本次变更主要为文档和工具改进，不涉及业务代码变更 - 用户信息配置工具需要 Node.js 环境支持 - 配置文件 `me.config.json` 已添加到 .gitignore，不会被提交 - 建议开发者在使用 AI 代码检查前先运行配置工具 - 英文文档为主要版本，后续维护应保持英文文档更新 ## 🚀 部署说明 - **部署环境**：文档更新无需特殊部署 - **部署时间**：随时可以合并 - **影响范围**：仅影响文档和开发工具，不影响运行时代码 - **回滚方案**：如有问题可快速回滚到上一版本（commit: 73e3e01） - **使用建议**： - 开发者首次使用 AI 代码检查时运行 `node tools/setup-user-info.js` - 参考英文版 README.md 了解完整检查流程 - 查阅 step1 和 step4 文档了解最新规范要求 ## 📄 相关文档 - AI 代码检查指南：`docs/ai-reading/README.md` - 命名规范文档：`docs/ai-reading/step1-naming-convention.md` - 架构分层文档：`docs/ai-reading/step4-architecture-layer.md` - 架构重构文档：`docs/ARCHITECTURE_REFACTORING.md` - 贡献者文档：`docs/CONTRIBUTORS.md` - 用户信息配置工具：`docs/ai-reading/tools/setup-user-info.js` ## 🎉 预期收益 1. **国际化水平提升**：英文文档便于国际开发者参与 2. **开发效率提升**：自动化工具减少手动配置时间 3. **代码质量提升**：更详细的规范说明减少违规情况 4. **团队协作提升**：统一的文档标准便于知识传递 5. **维护成本降低**：清晰的架构文档便于后续维护 ## 📈 后续计划 1. 根据实际使用反馈优化配置工具 2. 补充其他 AI 检查步骤的详细说明 3. 考虑添加中文版本文档（如有需求） 4. 持续完善架构重构文档 --- **文档生成时间**：2026-01-14 **对应分支**：feature/code-standard-auth-20260114 **远程仓库**：whale-town-end **合并状态**：待创建 PR **下一步操作**：访问 https://gitea.xinghangee.icu/datawhale/whale-town-end/pulls/new/feature/code-standard-auth-20260114 创建 Pull Request
moyin added 9 commits 2026-01-14 13:20:35 +08:00
refactor(auth): 移除Controller，专注于业务逻辑层 f7c3983cc1 
范围：src/business/auth/
涉及文件：
- src/business/auth/auth.module.ts
- src/business/auth/README.md

主要改进：
- 移除LoginController和RegisterController的导入和声明
- 调整模块结构，专注于业务逻辑层
- 更新README文档，明确Business Layer职责定位
- 完善依赖关系说明和架构层级描述
- 版本号从1.0.2升级到2.0.0（架构重构）
refactor(auth): 重构认证模块架构 - 将Gateway层组件从Business层分离 73e3e0153c 
范围：src/gateway/auth/, src/business/auth/, src/app.module.ts
涉及文件：
- 新增：src/gateway/auth/ 目录及所有文件
- 移动：Controller、Guard、Decorator、DTO从business层移至gateway层
- 修改：src/business/auth/index.ts（移除Gateway层组件导出）
- 修改：src/app.module.ts（使用AuthGatewayModule替代AuthModule）

主要改进：
- 明确Gateway层和Business层的职责边界
- Controller、Guard、Decorator属于Gateway层职责
- Business层专注于业务逻辑和服务
- 符合分层架构设计原则
config：更新 .gitignore 配置 f9a79461a0 
- 添加 docs/ai-reading/me.config.json 到忽略列表
- 优化配置文件结构
style：优化贡献者文档格式 f1dd8cd14a 
- 调整贡献者顺序展示
- 优化贡献统计表格排列
- 改善文档可读性
feat：添加 AI 代码检查用户信息配置工具 43874892b7 
- 新增 setup-user-info.js 脚本
- 自动获取当前日期并提示输入用户名
- 生成 me.config.json 配置文件供 AI 检查步骤使用
- 简化 AI 代码检查流程的用户信息收集
docs：将 AI 代码检查指南翻译为英文 8bcd22ea50 
- 将主要内容从中文翻译为英文
- 添加用户信息配置脚本使用说明
- 优化文档结构和可读性
- 保持原有检查流程和规范不变
docs：完善 NestJS 框架文件命名规范说明 41c33d6159 
- 详细说明 NestJS 文件命名规则（snake_case + 点分隔类型标识符）
- 添加正确和错误的命名示例对比
- 补充所有 NestJS 文件类型标识符列表
- 增加常见错误判断方法说明
docs：补充 Gateway 层架构规范检查说明 cf431c210a 
- 新增 Gateway 层职责定义和检查规范
- 添加 Gateway 层协议处理示例代码
- 补充 Gateway 层依赖关系和文件类型检查
- 完善 4 层架构说明（Gateway、Business、Core、Common）
- 增加 Gateway 层常见违规示例
docs：添加架构重构文档 a147883e05 
- 新增 ARCHITECTURE_REFACTORING.md 文档
- 记录项目架构重构计划和进度
moyin merged commit 963ebbd90d into main 2026-01-14 13:20:43 +08:00
moyin deleted branch feature/code-standard-auth-20260114 2026-01-14 13:20:43 +08:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
moyin
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: datawhale/whale-town-end#45
Delete Branch "feature/code-standard-auth-20260114"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?