docs: 完善项目文档和README,修复字符显示问题

- 修复README.md中的emoji字符显示问题
- 移除文档质量评级系统
- 添加贡献者致谢部分,创建详细的CONTRIBUTORS.md
- 创建核心系统文件EventNames.gd和ProjectPaths.gd
- 更新项目配置文件project.godot,添加输入映射
- 完善各模块文档,修正路径引用问题
- 创建文档更新日志CHANGELOG.md
- 优化文档结构和导航系统
This commit is contained in:
2025-12-31 18:58:38 +08:00
parent a85a7b4d0e
commit 0edd1c740b
18 changed files with 939 additions and 404 deletions

122
docs/CONTRIBUTORS.md Normal file
View File

@@ -0,0 +1,122 @@
# 🤝 项目贡献者
感谢所有为WhaleTown项目做出贡献的开发者
## 🏆 核心贡献者
### 主要开发者
#### 王浩
- **贡献数量**: 3+ commits
- **主要贡献**:
- 🏗️ 项目架构分层结构重构
- 📚 AI开发规范文档制定
- 📖 项目开发规范文档完善
#### moyin
- **贡献数量**: 35+ commits
- **主要贡献**:
- 🔧 项目功能开发和实现
- 📝 文档内容编写和维护
- 🧪 测试用例开发和验证
- 🌐 网络系统和部署配置
## 📊 贡献统计
### 按贡献类型
| 贡献类型 | 主要贡献者 | 说明 |
|----------|------------|------|
| **架构设计** | 王浩, moyin | 分层结构重构,模块化架构 |
| **开发规范** | 王浩 | AI开发规范、编码标准 |
| **文档建设** | moyin, 王浩 | 18个完整文档覆盖全开发流程 |
| **网络系统** | moyin | NetworkManager、API集成 |
| **测试框架** | moyin | API测试、UI测试、性能测试 |
| **认证系统** | moyin | 用户认证流程实现 |
| **部署系统** | moyin | Web部署、自动化脚本 |
### 按时间线
#### 2024年12月
- **架构重构**: 王浩 实施分层架构重构
- **规范制定**: 王浩 制定AI开发规范
- **项目开发**: moyin 完成主要功能开发
- **文档建设**: moyin, 王浩 建设文档系统
- **测试集成**: moyin 完成API集成和测试
## 🌟 贡献亮点
### 🏗️ 架构设计
- **分层结构**: 清晰的代码组织和职责分离
- **模块化架构**: 高度解耦的组件系统
- **事件驱动**: 基于EventSystem的通信机制
### 📚 文档建设
- **企业级文档**: 18个完整文档100%覆盖
- **分类组织**: 按开发阶段精心分类
- **实用导向**: 大量可直接使用的代码模板
### 🎯 开发规范
- **AI开发规范**: AI辅助开发的最佳实践
- **编码标准**: 统一的命名规范和代码风格
- **质量保证**: 完善的代码审查流程
### 🧪 测试体系
- **多层测试**: API、UI、单元、集成测试
- **自动化**: Python测试脚本和Godot测试场景
- **完整覆盖**: 17个API接口全覆盖
### 🌐 部署系统
- **一键部署**: 自动化Web部署脚本
- **跨平台**: 支持Windows、Linux、macOS
- **配置完善**: 详细的服务器配置指南
## 🎯 特别感谢
### 技术贡献
- **王浩**: 负责架构重构和开发规范制定
- **moyin**: 负责主要功能开发和文档编写
### 架构贡献
- **分层结构**: 提升了项目的代码组织和可维护性
- **模块化设计**: 为项目扩展奠定了良好基础
- **开发规范**: 统一了团队的开发标准
## 🚀 如何成为贡献者
### 贡献方式
1. **🐛 Bug修复** - 发现并修复问题
2. **✨ 新功能** - 添加有价值的功能
3. **📚 文档改进** - 完善项目文档
4. **🧪 测试用例** - 提高代码覆盖率
5. **🎨 UI/UX改进** - 提升用户体验
6. **⚡ 性能优化** - 优化游戏性能
### 贡献流程
1. Fork项目到你的账户
2. 创建功能分支:`git checkout -b feature/your-feature`
3. 遵循项目规范开发
4. 添加测试用例
5. 提交代码:`git commit -m "feat添加新功能"`
6. 创建Pull Request
### 规范要求
- 遵循[命名规范](02-开发规范/命名规范.md)
- 遵循[Git提交规范](02-开发规范/Git提交规范.md)
- 遵循[代码注释规范](02-开发规范/代码注释规范.md)
- 添加相应的测试用例
- 更新相关文档
## 📞 联系方式
如果你想参与贡献或有任何问题:
- **项目地址**: [Gitea Repository](https://gitea.xinghangee.icu/datawhale/whale-town)
- **问题反馈**: [Issues](https://gitea.xinghangee.icu/datawhale/whale-town/issues)
- **功能建议**: [Discussions](https://gitea.xinghangee.icu/datawhale/whale-town/discussions)
---
**感谢所有贡献者的辛勤付出每个人的贡献都让WhaleTown项目变得更好。** 🙏
*最后更新: 2025-12-31*