moyin
0edd1c740b
- 修复README.md中的emoji字符显示问题 - 移除文档质量评级系统 - 添加贡献者致谢部分，创建详细的CONTRIBUTORS.md - 创建核心系统文件EventNames.gd和ProjectPaths.gd - 更新项目配置文件project.godot，添加输入映射 - 完善各模块文档，修正路径引用问题 - 创建文档更新日志CHANGELOG.md - 优化文档结构和导航系统
📋 开发规范
适用人群: 所有开发者
使用时机: 编码过程中，代码审查时
这个目录包含了项目的所有编码标准和开发规范，确保团队代码风格一致，架构设计统一。
📚 规范文档
基础规范 📝
- 文件、类、变量、函数命名标准
- 资源文件命名规则
- 目录结构命名约定
- 注释格式和标准
- 文档生成规范
- AI辅助开发指南
- 提交信息格式标准
- 分支管理策略
- 代码审查流程
架构规范 🏗️
- 分层架构设计原则
- EventSystem事件系统使用
- 组件间通信标准
- 单例管理规范
质量标准 ⭐
- 项目开发理念
- 代码质量标准
- 最佳实践指导
- 代码审查清单
🎯 使用指南
新人学习路径
- 命名规范 - 学会正确命名
- 架构与通信规范 - 理解项目架构
- 开发哲学与最佳实践 - 掌握质量标准
- 代码注释规范 - 学会写好注释
- Git提交规范 - 规范版本控制
日常开发参考
- 编码时参考 命名规范 和 架构规范
- 提交代码前检查 最佳实践 清单
- 写注释时遵循 注释规范
- 提交时遵循 Git规范
代码审查要点
- 命名是否符合规范
- 架构设计是否合理
- 代码质量是否达标
- 注释是否完整清晰
- 提交信息是否规范
⚠️ 重要提醒
强制性规范
以下规范是强制性的，必须严格遵守：
- 文件和目录命名规范
- EventSystem通信规范
- 类型安全要求
- Git提交格式
建议性规范
以下规范是建议性的，推荐遵循：
- 代码注释的详细程度
- 函数长度和复杂度
- 性能优化建议
🔄 规范更新
更新原则
- 规范变更需要团队讨论
- 重大变更需要文档化说明
- 保持向后兼容性
更新流程
- 提出规范变更建议
- 团队讨论和评审
- 更新相关文档
- 通知所有开发者
🤝 团队协作
规范执行
- 代码审查时严格检查规范遵循情况
- 定期进行规范培训和分享
- 鼓励团队成员提出改进建议
问题反馈
如果发现规范问题或有改进建议：
- 创建Issue讨论
- 在团队会议中提出
- 通过PR提交改进方案
记住：规范不是束缚，而是团队协作的基础！