Files

moyin 7924cfb201 docs：重构README和贡献者文档，完善项目架构说明和测试指南

- 重构README结构，按新开发者学习流程组织内容
- 更新项目架构图和技术栈说明，基于实际代码结构
- 创建CONTRIBUTORS.md，记录所有贡献者信息和统计
- 添加TESTING.md测试指南，支持无依赖快速测试
- 创建docs/ARCHITECTURE.md详细架构设计文档
- 优化.env.example配置，支持测试和生产环境切换
- 添加跨平台测试脚本(test-api.ps1/test-api.sh)
- 删除冗余测试文件，统一测试入口
- 更新所有链接为正确的Gitea仓库地址
- 添加MIT开源协议文件

2025-12-18 15:03:09 +08:00

3.2 KiB

Raw Permalink Blame History

贡献者名单

感谢所有为 Whale Town 项目做出贡献的开发者们！🎉

核心贡献者

🏆 主要维护者

moyin - 主要维护者

Gitea: @moyin
Email: xinghang_a@proton.me
提交数: 66 commits
主要贡献：
- 🚀 项目架构设计与初始化
- 🔐 完整用户认证系统实现
- 📧 邮箱验证系统设计与开发
- 🗄️ Redis缓存服务（文件存储+真实Redis双模式）
- 📝 完整的API文档系统（Swagger UI + OpenAPI）
- 🧪 测试框架搭建与114个测试用例编写
- 📊 高性能日志系统集成（Pino）
- 🔧 项目配置优化与部署方案
- 🐛 验证码TTL重置关键问题修复
- 📚 完整的项目文档体系建设

🌟 核心开发者

angjustinl - 核心开发者

Gitea: @ANGJustinl
GitHub: @ANGJustinl
Email: 96008766+ANGJustinl@users.noreply.github.com
提交数: 2 commits
主要贡献：
- 🔄 邮箱验证流程重构与优化
- 💾 基于内存的用户服务实现
- 🛠️ API响应处理改进
- 🧪 测试用例完善与错误修复
- 📚 系统架构优化

jianuo - 核心开发者

Gitea: @jianuo
Email: 32106500027@e.gzhu.edu.cn
提交数: 3 commits
主要贡献：
- 🐳 Docker部署问题修复
- 📖 项目文档错误修复
- 🔧 部署配置优化

贡献统计

贡献者	提交数	主要领域	贡献占比
moyin	66	架构设计、核心功能、文档、测试	93%
jianuo	3	部署、文档	4%
angjustinl	2	功能优化、测试、重构	3%

项目里程碑

2025年12月

12月17日: 项目初始化，完成基础架构搭建
12月17日: 实现完整的用户认证系统
12月17日: 完成API文档系统集成
12月17日: 实现邮箱验证系统
12月17日: 修复验证码TTL重置关键问题
12月18日: angjustinl重构邮箱验证流程，引入内存用户服务
12月18日: jianuo修复Docker部署问题
12月18日: 完成测试用例修复和优化

如何成为贡献者

我们欢迎所有形式的贡献！无论是：

🐛 Bug修复 - 发现并修复问题
✨ 新功能 - 添加有价值的功能
📚 文档改进 - 完善项目文档
🧪 测试用例 - 提高代码覆盖率
🎨 代码优化 - 改进代码质量
💡 建议反馈 - 提出改进建议

贡献流程

Fork 项目到你的Gitea账户
创建功能分支：git checkout -b feature/your-feature
提交你的更改：git commit -m "feat：添加新功能"
推送到分支：git push origin feature/your-feature
创建Pull Request

贡献规范

请在贡献前阅读：

再次感谢所有贡献者的辛勤付出！ 🙏

如果你的名字没有出现在列表中，请联系我们或提交PR更新此文件。

3.2 KiB Raw Permalink Blame History Unescape Escape