diff --git a/docs/CONTRIBUTORS.md b/docs/CONTRIBUTORS.md index 9e4f6a4..c533b32 100644 --- a/docs/CONTRIBUTORS.md +++ b/docs/CONTRIBUTORS.md @@ -4,116 +4,149 @@ ## 核心贡献者 +### � 项目维护者 + +**moyin** - 项目维护者 +- Gitea: [@moyin](https://gitea.xinghangee.icu/moyin) +- Email: xinghang_a@proton.me +- 提交数: **166 commits** (不含合并提交) +- 主要贡献： + - 🚀 **项目架构设计** - 四层架构（Gateway-Business-Core-Data）设计与实现 + - � **用户认证系统** - 完整的登录、注册、JWT认证、验证码登录 + - 📧 **邮箱验证系统** - 邮件服务、验证码服务、冷却时间机制 + - �️ **双模式架构** - Redis缓存（文件/真实）、用户服务（内存/数据库） + - � **API文档系统** - Swagger UI、OpenAPI规范、WebSocket文档 + - 🧪 **测试框架** - Jest配置、507+测试用例、集成测试、E2E测试 + - � **日志系统** - Pino高性能日志、结构化日志、日志管理 + - 🏗️ **架构重构** - Zulip模块重构、认证模块分层、安全模块迁移 + - 📚 **文档体系** - 架构文档、开发规范、AI代码检查指南、部署文档 + - 🎮 **游戏功能** - 位置广播系统、通知系统、地图房间管理 + - 🔧 **项目配置** - TypeScript配置、构建配置、环境配置、Docker部署 + - 🐛 **问题修复** - 验证码TTL重置、依赖注入、HTTP状态码、数据库管理 + ### 🌟 核心开发者 +**jianuo** - 核心开发者 +- Gitea: [@jianuo](https://gitea.xinghangee.icu/jianuo) +- Email: 32106500027@e.gzhu.edu.cn +- 提交数: **10 commits** (不含合并提交) +- 主要贡献： + - 🎛️ **管理员后台系统** - React前端界面、Ant Design组件、完整CRUD功能 + - 📊 **日志管理功能** - 运行时日志查看、日志下载、日志分析 + - � **管理员认证** - 独立Token认证、权限控制、会话管理 + - 🧪 **单元测试** - 管理员功能测试用例、测试覆盖率提升 + - ⚙️ **TypeScript配置** - Node16模块解析、编译配置优化 + - 🐳 **Docker部署** - 容器化部署问题修复、部署脚本优化 + - 📖 **文档维护** - 技术栈文档、部署文档、错误修复文档 + **angjustinl** - 核心开发者 - Gitea: [@ANGJustinl](https://gitea.xinghangee.icu/ANGJustinl) - GitHub: [@ANGJustinl](https://github.com/ANGJustinl) - Email: 96008766+ANGJustinl@users.noreply.github.com -- 提交数: **7 commits** +- 提交数: **9 commits** (不含合并提交) - 主要贡献： - - 🔄 邮箱验证流程重构与优化 - - 💾 基于内存的用户服务实现 - - 🛠️ API响应处理改进 - - 🧪 测试用例完善与错误修复 - - 📚 系统架构优化 - - 💬 **Zulip集成系统** - 完整的Zulip实时通信系统开发 - - 🔧 **E2E测试修复** - Zulip集成的端到端测试优化 - - 🎯 **验证码登录测试** - 验证码登录功能测试用例编写 - -**jianuo** - 核心开发者 -- Gitea: [@jianuo](https://gitea.xinghangee.icu/jianuo) -- Email: 32106500027@e.gzhu.edu.cn -- 提交数: **11 commits** -- 主要贡献： - - 🎛️ **管理员后台系统** - 完整的前后端管理界面开发 - - 📊 **日志管理功能** - 运行时日志查看与下载系统 - - 🔐 **管理员认证系统** - 独立Token认证与权限控制 - - 🧪 **单元测试完善** - 管理员功能测试用例编写 - - ⚙️ **TypeScript配置优化** - Node16模块解析配置 - - 🐳 **Docker部署优化** - 容器化部署问题修复 - - 📖 **技术栈文档更新** - 项目技术栈说明完善 - - 🔧 **项目配置优化** - 构建和开发环境配置改进 - -### 🏆 主要维护者 - -**moyin** - 主要维护者 -- Gitea: [@moyin](https://gitea.xinghangee.icu/moyin) -- Email: xinghang_a@proton.me -- 提交数: **112 commits** -- 主要贡献： - - 🚀 项目架构设计与初始化 - - 🔐 完整用户认证系统实现 - - 📧 邮箱验证系统设计与开发 - - 🗄️ Redis缓存服务（文件存储+真实Redis双模式） - - 📝 完整的API文档系统（Swagger UI + OpenAPI） - - 🧪 测试框架搭建与507个测试用例编写 - - 📊 高性能日志系统集成（Pino） - - 🔧 项目配置优化与部署方案 - - 🐛 验证码TTL重置关键问题修复 - - 📚 完整的项目文档体系建设 - - 🏗️ **Zulip模块架构重构** - 业务功能模块化架构设计与实现 - - 📖 **架构文档重写** - 详细的架构设计文档和开发者指南 - - 🔄 **验证码冷却时间优化** - 自动清除机制设计与实现 - - 📋 **文档清理优化** - 项目文档结构化整理和维护体系建立 + - � **Zulip集成系统** - 完整的Zulip实时通信系统、WebSocket连接、消息同步 + - 🔑 **JWT认证重构** - JWT验证机制、API密钥管理、Token刷新 + - � **邮箱验证重构** - 验证流程优化、内存用户服务、API响应改进 + - � **验证码登录** - 验证码登录功能实现、测试用例编写 + - 🧪 **测试优化** - E2E测试修复、测试断言更新、测试覆盖完善 + - 🏗️ **Zulip账户管理** - Zulip账户创建、绑定、同步机制 ## 贡献统计 | 贡献者 | 提交数 | 主要领域 | 贡献占比 | |--------|--------|----------|----------| -| angjustinl | 7 | Zulip集成、功能优化、测试、重构 | 5% | -| jianuo | 11 | 管理员后台、日志系统、部署优化、配置管理 | 8% | -| moyin | 112 | 架构设计、核心功能、文档、测试、Zulip重构 | 86% | +| moyin | 166 | 架构设计、核心功能、文档、测试、重构 | 89.7% | +| jianuo | 10 | 管理员后台、日志系统、部署优化 | 5.4% | +| angjustinl | 9 | Zulip集成、JWT认证、验证码登录 | 4.9% | ## 🌟 最新重要贡献 -### 🏗️ Zulip模块架构重构 (2025年12月31日) -**主要贡献者**: moyin, angjustinl - -这是项目历史上最重要的架构重构之一： - -- **架构重构**: 实现业务功能模块化架构，将Zulip模块按照业务层和核心层进行清晰分离 -- **代码迁移**: 36个文件的重构和迁移，涉及2773行代码的新增和125行的删除 -- **依赖注入**: 通过接口抽象实现业务层与核心层的完全解耦 -- **测试完善**: 所有507个测试用例通过，确保重构的安全性 - -### 📚 项目文档体系优化 (2025年12月31日) +### 🏗️ 四层架构重构与规范化 (2026年1月) **主要贡献者**: moyin -- **架构文档重写**: `docs/ARCHITECTURE.md` 从简单架构图扩展为800+行的完整架构设计文档 -- **README优化**: 采用总分结构设计，详细的文件结构总览 -- **文档清理**: 新增 `docs/DOCUMENT_CLEANUP.md` 记录文档维护过程 -- **开发者体验**: 建立完整的文档导航体系，提升开发者上手体验 +项目完成了重大的架构升级和代码规范化工作： -### 💬 Zulip集成系统 (2025年12月25日) -**主要贡献者**: angjustinl +- **认证模块重构** (1月14日): 将Gateway层组件从Business层分离，实现清晰的四层架构 +- **依赖注入优化** (1月14日): 修复AuthGatewayModule依赖注入问题，完善NestJS模块系统 +- **AI代码检查体系** (1月14日): 建立完整的AI辅助代码检查流程和规范文档 +- **架构文档完善** (1月14日): 新增架构重构文档、Gateway层规范、NestJS命名规范 +- **代码规范优化** (1月12日): 完善多个核心模块的代码规范和测试覆盖 -- **完整集成**: 实现与Zulip的完整集成，支持实时通信功能 -- **WebSocket支持**: 建立稳定的WebSocket连接和消息处理机制 -- **测试覆盖**: 完善的E2E测试确保集成功能的稳定性 +### 📚 代码质量与测试提升 (2026年1月) +**主要贡献者**: moyin + +- **测试覆盖完善** (1月12日): 完善users、zulip、verification等模块测试覆盖 +- **文档体系建设** (1月12日): 添加开发者代码检查规范、AI代码检查执行指南 +- **性能优化** (1月12日): 集成高性能缓存系统和结构化日志 +- **模块功能扩展** (1月12日): 添加Zulip动态配置控制器和账户业务服务 + +### 🎮 游戏功能扩展 (2026年1月) +**主要贡献者**: moyin + +- **通知系统** (1月10日): 实现完整的通知系统核心功能和数据库支持 +- **WebSocket优化** (1月9日): 统一WebSocket网关配置、增强测试页面用户体验 +- **原生WebSocket** (1月9日): 移除Socket.IO依赖，实现原生WebSocket支持 +- **位置广播系统** (1月8日): 实现位置广播系统和端到端测试 +- **管理员系统** (1月8日): 完善管理员系统核心功能和用户管理模块 + +### 🏗️ Zulip模块架构重构 (2025年12月) +**主要贡献者**: moyin, angjustinl + +- **架构重构** (12月31日): 实现业务功能模块化架构，清晰分离业务层和核心层 +- **Zulip集成** (12月25日): angjustinl开发完整的Zulip实时通信系统 +- **JWT认证** (1月6日): angjustinl引入JWT验证并重构API密钥管理 +- **账户管理** (1月5日): angjustinl添加Zulip账户管理和认证系统集成 ## 项目里程碑 +### 2026年1月 +- **1月14日**: 🏗️ 认证模块四层架构重构，Gateway层与Business层清晰分离 +- **1月14日**: 🔧 修复AuthGatewayModule依赖注入问题，完善模块系统 +- **1月14日**: 📚 建立AI代码检查体系，添加完整的规范文档 +- **1月14日**: 📖 新增架构重构文档和NestJS框架规范说明 +- **1月12日**: ✨ 完善多个核心模块的代码规范和测试覆盖 +- **1月12日**: 🧪 添加Zulip业务模块完整测试覆盖 +- **1月12日**: 📝 添加开发者代码检查规范和AI检查执行指南 +- **1月12日**: ⚡ 集成高性能缓存系统和结构化日志 +- **1月10日**: 🔔 实现通知系统核心功能和数据库支持 +- **1月10日**: 🐛 修复数据库管理服务的关键问题 +- **1月9日**: 🌐 统一WebSocket网关配置，增强测试页面 +- **1月9日**: 🔄 移除Socket.IO依赖，实现原生WebSocket支持 +- **1月8日**: 📍 实现位置广播系统和端到端测试 +- **1月8日**: 👑 完善管理员系统核心功能 +- **1月8日**: 🏗️ 项目架构重构和命名规范化 +- **1月7日**: 📦 升级到v2.0.0版本 +- **1月6日**: 🔑 angjustinl引入JWT验证并重构API密钥管理 +- **1月5日**: 👤 angjustinl添加Zulip账户管理和认证系统集成 +- **1月4日**: 🛡️ 重构安全模块架构，迁移至core层 + ### 2025年12月 -- **12月17日**: 项目初始化，完成基础架构搭建 -- **12月17日**: 实现完整的用户认证系统 -- **12月17日**: 完成API文档系统集成 -- **12月17日**: 实现邮箱验证系统 -- **12月17日**: 修复验证码TTL重置关键问题 -- **12月18日**: angjustinl重构邮箱验证流程，引入内存用户服务 -- **12月18日**: jianuo修复Docker部署问题 -- **12月18日**: 完成测试用例修复和优化 -- **12月19日**: jianuo开发管理员后台系统 -- **12月20日**: jianuo完善日志管理功能 -- **12月21日**: jianuo添加管理员后台单元测试 -- **12月22日**: 管理员后台功能合并到主分支 -- **12月25日**: angjustinl开发完整的Zulip集成系统 -- **12月25日**: 实现验证码冷却时间自动清除机制 -- **12月25日**: 完成邮箱冲突检测优化v1.1.1 -- **12月25日**: 升级项目版本到v1.1.0 -- **12月31日**: **重大架构重构** - 完成Zulip模块业务功能模块化架构重构 -- **12月31日**: **文档体系优化** - 项目文档结构化整理和架构文档重写 -- **12月31日**: **测试覆盖完善** - 所有507个测试用例通过，测试覆盖率达到新高 +- **12月31日**: 🏗️ Zulip模块业务功能模块化架构重构 +- **12月31日**: 📚 项目文档结构化整理和架构文档重写 +- **12月25日**: 💬 angjustinl开发完整的Zulip集成系统 +- **12月25日**: 🔄 实现验证码冷却时间自动清除机制 +- **12月25日**: 📧 完成邮箱冲突检测优化v1.1.1 +- **12月25日**: 🎯 angjustinl实现验证码登录功能 +- **12月25日**: 📈 升级项目版本到v1.1.0 +- **12月24日**: 🐛 修复注册逻辑和HTTP状态码问题 +- **12月24日**: 🔧 修复API状态码和限流配置问题 +- **12月24日**: 🏗️ 重构项目结构和业务模块架构 +- **12月23日**: 📖 全面更新API接口文档 +- **12月22日**: 🎛️ jianuo的管理员后台功能合并到主分支 +- **12月19日**: 👑 jianuo开发管理员后台系统 +- **12月19日**: 📊 jianuo完善日志管理功能 +- **12月19日**: 🧪 jianuo添加管理员后台单元测试 +- **12月19日**: ⚙️ jianuo优化TypeScript配置 +- **12月18日**: 🔄 angjustinl重构邮箱验证流程，引入内存用户服务 +- **12月18日**: 🐳 jianuo修复Docker部署问题 +- **12月18日**: 🧪 完成测试用例修复和优化 +- **12月17日**: 🐛 修复验证码TTL重置关键问题 +- **12月17日**: 📧 实现完整的邮箱验证系统 +- **12月17日**: 🗄️ 实现Redis缓存服务（双模式） +- **12月17日**: 📝 完成API文档系统集成 +- **12月17日**: 🔐 实现完整的用户认证系统 +- **12月17日**: 🚀 项目初始化，完成基础架构搭建 ## 如何成为贡献者 @@ -137,9 +170,10 @@ ### 贡献规范 请在贡献前阅读： -- [AI辅助开发规范指南](./docs/AI辅助开发规范指南.md) -- [后端开发规范](./docs/backend_development_guide.md) -- [Git提交规范](./docs/git_commit_guide.md) +- [开发者代码检查规范](./开发者代码检查规范.md) +- [后端开发规范](./development/backend_development_guide.md) +- [Git提交规范](./development/git_commit_guide.md) +- [AI代码检查指南](./ai-reading/README.md) ---