From 1ff677b3b25607116d77292d5f3a152c4a4437c8 Mon Sep 17 00:00:00 2001 From: moyin <2443444649@qq.com> Date: Wed, 31 Dec 2025 18:02:16 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E9=87=8D=E6=96=B0=E7=BB=84=E7=BB=87?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=BB=93=E6=9E=84=EF=BC=8C=E6=8C=89=E5=BC=80?= =?UTF-8?q?=E5=8F=91=E9=98=B6=E6=AE=B5=E5=88=86=E7=B1=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 新的目录结构: 01-项目入门/ # 新人必读，项目基础 02-开发规范/ # 编码标准和规范 03-技术实现/ # 具体开发指导 04-高级开发/ # 进阶开发技巧 05-部署运维/ # 发布和部署 06-功能模块/ # 特定功能文档 新增导航文档: - docs/README.md - 完整的文档导航和使用指南 - 各目录下的README.md - 分类说明和使用指导 优化效果: - 开发者可以按阶段快速定位需要的文档 - 新人有清晰的学习路径 - 不同角色有针对性的文档推荐 - 提供了问题导向的快速查找功能 --- docs/01-项目入门/README.md | 47 +++++ .../输入映射配置.md | 0 .../项目结构说明.md | 0 .../项目设置指南.md | 0 docs/{ => 02-开发规范}/Git提交规范.md | 0 docs/02-开发规范/README.md | 105 +++++++++++ .../代码注释规范.md | 0 docs/{ => 02-开发规范}/命名规范.md | 0 .../开发哲学与最佳实践.md | 0 .../架构与通信规范.md | 0 docs/{ => 03-技术实现}/API接口文档.md | 0 docs/03-技术实现/README.md | 120 ++++++++++++ .../实现细节规范.md | 0 docs/{ => 03-技术实现}/测试指南.md | 0 .../网络管理器设置.md | 0 .../场景设计规范.md | 0 .../性能优化指南.md | 0 .../模块开发指南.md | 0 docs/{ => 05-部署运维}/Web部署指南.md | 0 .../auth/表单验证规范.md | 0 .../auth/认证测试指南.md | 0 docs/README.md | 177 ++++++++++++++++++ 22 files changed, 449 insertions(+) create mode 100644 docs/01-项目入门/README.md rename docs/{ => 01-项目入门}/输入映射配置.md (100%) rename docs/{ => 01-项目入门}/项目结构说明.md (100%) rename docs/{ => 01-项目入门}/项目设置指南.md (100%) rename docs/{ => 02-开发规范}/Git提交规范.md (100%) create mode 100644 docs/02-开发规范/README.md rename docs/{ => 02-开发规范}/代码注释规范.md (100%) rename docs/{ => 02-开发规范}/命名规范.md (100%) rename docs/{ => 02-开发规范}/开发哲学与最佳实践.md (100%) rename docs/{ => 02-开发规范}/架构与通信规范.md (100%) rename docs/{ => 03-技术实现}/API接口文档.md (100%) create mode 100644 docs/03-技术实现/README.md rename docs/{ => 03-技术实现}/实现细节规范.md (100%) rename docs/{ => 03-技术实现}/测试指南.md (100%) rename docs/{ => 03-技术实现}/网络管理器设置.md (100%) rename docs/{ => 04-高级开发}/场景设计规范.md (100%) rename docs/{ => 04-高级开发}/性能优化指南.md (100%) rename docs/{ => 04-高级开发}/模块开发指南.md (100%) rename docs/{ => 05-部署运维}/Web部署指南.md (100%) rename docs/{ => 06-功能模块}/auth/表单验证规范.md (100%) rename docs/{ => 06-功能模块}/auth/认证测试指南.md (100%) create mode 100644 docs/README.md diff --git a/docs/01-项目入门/README.md b/docs/01-项目入门/README.md new file mode 100644 index 0000000..5f937ed --- /dev/null +++ b/docs/01-项目入门/README.md @@ -0,0 +1,47 @@ +# 📖 项目入门 + +> **适用人群**: 新加入项目的开发者 +> **使用时机**: 项目开始前，环境搭建阶段 + +这个目录包含了新人入门必读的基础文档，帮助你快速了解项目并搭建开发环境。 + +## 📋 阅读顺序 + +### 第一步：了解项目 🏗️ +**[项目结构说明.md](项目结构说明.md)** +- 项目整体架构设计 +- 目录组织规则 +- 各层级职责说明 +- 团队协作方式 + +### 第二步：配置环境 ⚙️ +**[项目设置指南.md](项目设置指南.md)** +- Godot编辑器配置 +- AutoLoad单例设置 +- 开发环境验证 + +### 第三步：设置控制 🎮 +**[输入映射配置.md](输入映射配置.md)** +- 游戏输入控制配置 +- 键盘和手柄映射 +- 输入系统测试 + +## ✅ 完成检查 + +阅读完本目录的文档后，你应该能够： +- [ ] 理解项目的整体架构 +- [ ] 成功配置Godot开发环境 +- [ ] 正确设置游戏输入映射 +- [ ] 运行项目并进行基本测试 + +## 🔗 下一步 + +完成项目入门后，建议继续阅读： +- [02-开发规范](../02-开发规范/) - 学习编码标准 +- [03-技术实现](../03-技术实现/) - 开始具体开发 + +## 💡 小贴士 + +- 遇到问题时，先查看对应文档的"常见问题"部分 +- 建议在实际操作中边读边做，加深理解 +- 可以将重要的配置信息做笔记备用 \ No newline at end of file diff --git a/docs/输入映射配置.md b/docs/01-项目入门/输入映射配置.md similarity index 100% rename from docs/输入映射配置.md rename to docs/01-项目入门/输入映射配置.md diff --git a/docs/项目结构说明.md b/docs/01-项目入门/项目结构说明.md similarity index 100% rename from docs/项目结构说明.md rename to docs/01-项目入门/项目结构说明.md diff --git a/docs/项目设置指南.md b/docs/01-项目入门/项目设置指南.md similarity index 100% rename from docs/项目设置指南.md rename to docs/01-项目入门/项目设置指南.md diff --git a/docs/Git提交规范.md b/docs/02-开发规范/Git提交规范.md similarity index 100% rename from docs/Git提交规范.md rename to docs/02-开发规范/Git提交规范.md diff --git a/docs/02-开发规范/README.md b/docs/02-开发规范/README.md new file mode 100644 index 0000000..b7fe03b --- /dev/null +++ b/docs/02-开发规范/README.md @@ -0,0 +1,105 @@ +# 📋 开发规范 + +> **适用人群**: 所有开发者 +> **使用时机**: 编码过程中，代码审查时 + +这个目录包含了项目的所有编码标准和开发规范，确保团队代码风格一致，架构设计统一。 + +## 📚 规范文档 + +### 基础规范 📝 +**[命名规范.md](命名规范.md)** +- 文件、类、变量、函数命名标准 +- 资源文件命名规则 +- 目录结构命名约定 + +**[代码注释规范.md](代码注释规范.md)** +- 注释格式和标准 +- 文档生成规范 +- AI辅助开发指南 + +**[Git提交规范.md](Git提交规范.md)** +- 提交信息格式标准 +- 分支管理策略 +- 代码审查流程 + +### 架构规范 🏗️ +**[架构与通信规范.md](架构与通信规范.md)** +- 分层架构设计原则 +- EventSystem事件系统使用 +- 组件间通信标准 +- 单例管理规范 + +### 质量标准 ⭐ +**[开发哲学与最佳实践.md](开发哲学与最佳实践.md)** +- 项目开发理念 +- 代码质量标准 +- 最佳实践指导 +- 代码审查清单 + +## 🎯 使用指南 + +### 新人学习路径 +1. **命名规范** - 学会正确命名 +2. **架构与通信规范** - 理解项目架构 +3. **开发哲学与最佳实践** - 掌握质量标准 +4. **代码注释规范** - 学会写好注释 +5. **Git提交规范** - 规范版本控制 + +### 日常开发参考 +- 编码时参考 **命名规范** 和 **架构规范** +- 提交代码前检查 **最佳实践** 清单 +- 写注释时遵循 **注释规范** +- 提交时遵循 **Git规范** + +### 代码审查要点 +- [ ] 命名是否符合规范 +- [ ] 架构设计是否合理 +- [ ] 代码质量是否达标 +- [ ] 注释是否完整清晰 +- [ ] 提交信息是否规范 + +## ⚠️ 重要提醒 + +### 强制性规范 +以下规范是**强制性**的，必须严格遵守： +- 文件和目录命名规范 +- EventSystem通信规范 +- 类型安全要求 +- Git提交格式 + +### 建议性规范 +以下规范是**建议性**的，推荐遵循： +- 代码注释的详细程度 +- 函数长度和复杂度 +- 性能优化建议 + +## 🔄 规范更新 + +### 更新原则 +- 规范变更需要团队讨论 +- 重大变更需要文档化说明 +- 保持向后兼容性 + +### 更新流程 +1. 提出规范变更建议 +2. 团队讨论和评审 +3. 更新相关文档 +4. 通知所有开发者 + +## 🤝 团队协作 + +### 规范执行 +- 代码审查时严格检查规范遵循情况 +- 定期进行规范培训和分享 +- 鼓励团队成员提出改进建议 + +### 问题反馈 +如果发现规范问题或有改进建议： +- 创建Issue讨论 +- 在团队会议中提出 +- 通过PR提交改进方案 + +--- + +**记住：规范不是束缚，而是团队协作的基础！** \ No newline at end of file diff --git a/docs/代码注释规范.md b/docs/02-开发规范/代码注释规范.md similarity index 100% rename from docs/代码注释规范.md rename to docs/02-开发规范/代码注释规范.md diff --git a/docs/命名规范.md b/docs/02-开发规范/命名规范.md similarity index 100% rename from docs/命名规范.md rename to docs/02-开发规范/命名规范.md diff --git a/docs/开发哲学与最佳实践.md b/docs/02-开发规范/开发哲学与最佳实践.md similarity index 100% rename from docs/开发哲学与最佳实践.md rename to docs/02-开发规范/开发哲学与最佳实践.md diff --git a/docs/架构与通信规范.md b/docs/02-开发规范/架构与通信规范.md similarity index 100% rename from docs/架构与通信规范.md rename to docs/02-开发规范/架构与通信规范.md diff --git a/docs/API接口文档.md b/docs/03-技术实现/API接口文档.md similarity index 100% rename from docs/API接口文档.md rename to docs/03-技术实现/API接口文档.md diff --git a/docs/03-技术实现/README.md b/docs/03-技术实现/README.md new file mode 100644 index 0000000..9141865 --- /dev/null +++ b/docs/03-技术实现/README.md @@ -0,0 +1,120 @@ +# 🔧 技术实现 + +> **适用人群**: 正在开发功能的程序员 +> **使用时机**: 具体功能开发时 + +这个目录包含了具体的技术实现指导，帮助开发者快速实现各种游戏功能和系统集成。 + +## 📋 实现指南 + +### 核心实现 🎮 +**[实现细节规范.md](实现细节规范.md)** +- 玩家角色实现标准 +- NPC交互系统实现 +- TileMap图层配置规范 +- 交互物品实现模板 +- 性能优化要求 + +### 网络集成 🌐 +**[API接口文档.md](API接口文档.md)** +- 完整的后端API接口说明 +- 请求格式和响应格式 +- 错误码和处理方式 +- 认证和权限管理 + +**[网络管理器设置.md](网络管理器设置.md)** +- NetworkManager配置方法 +- 网络请求封装使用 +- 错误处理机制 +- 响应数据处理 + +### 质量保证 🧪 +**[测试指南.md](测试指南.md)** +- API接口测试方法 +- Python测试脚本使用 +- Godot内置测试 +- 测试用例编写 + +## 🎯 开发流程 + +### 功能开发标准流程 +1. **需求分析** - 明确功能需求和技术方案 +2. **架构设计** - 参考实现细节规范设计架构 +3. **编码实现** - 按照规范编写代码 +4. **接口集成** - 使用API文档进行后端集成 +5. **功能测试** - 使用测试指南验证功能 +6. **代码审查** - 检查规范遵循情况 + +### 常见开发场景 + +#### 🎮 实现新的游戏角色 +1. 阅读 [实现细节规范.md](实现细节规范.md) 中的角色实现部分 +2. 使用提供的代码模板创建角色 +3. 配置相机和交互系统 +4. 测试移动和交互功能 + +#### 🌐 集成新的API接口 +1. 查看 [API接口文档.md](API接口文档.md) 了解接口规范 +2. 使用 [网络管理器设置.md](网络管理器设置.md) 配置网络请求 +3. 实现数据处理和错误处理 +4. 使用 [测试指南.md](测试指南.md) 验证接口功能 + +#### 🗺️ 创建新的游戏场景 +1. 参考 [实现细节规范.md](实现细节规范.md) 中的TileMap配置 +2. 设置正确的图层结构和碰撞检测 +3. 配置相机边界和Y排序 +4. 添加交互物品和NPC + +## 🔍 问题排查 + +### 常见问题类型 + +#### 网络相关问题 +- **API调用失败** → 检查 [API接口文档.md](API接口文档.md) 中的接口格式 +- **网络超时** → 参考 [网络管理器设置.md](网络管理器设置.md) 的超时配置 +- **数据解析错误** → 查看响应格式和错误处理 + +#### 游戏对象问题 +- **角色移动异常** → 检查 [实现细节规范.md](实现细节规范.md) 中的移动实现 +- **交互不响应** → 验证InteractionArea配置和事件系统 +- **相机边界错误** → 检查TileMap边界计算 + +#### 性能问题 +- **帧率下降** → 参考性能优化要求 +- **内存泄漏** → 检查资源管理和对象生命周期 + +### 调试技巧 +1. **使用Godot调试器** - 设置断点调试代码逻辑 +2. **查看控制台输出** - 关注错误和警告信息 +3. **使用测试脚本** - 编写简单测试验证功能 +4. **性能分析** - 使用Godot的性能分析工具 + +## 📚 参考资源 + +### 内部资源 +- [02-开发规范](../02-开发规范/) - 编码规范和架构设计 +- [04-高级开发](../04-高级开发/) - 进阶开发技巧 +- [06-功能模块](../06-功能模块/) - 特定功能实现 + +### 外部资源 +- [Godot官方文档](https://docs.godotengine.org/) +- [GDScript语言参考](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/) +- [Godot最佳实践](https://docs.godotengine.org/en/stable/tutorials/best_practices/) + +## 💡 开发建议 + +### 效率提升 +- 使用代码模板快速创建标准结构 +- 善用Godot的场景实例化功能 +- 合理使用@export变量进行配置 +- 充分利用事件系统解耦组件 + +### 质量保证 +- 每个功能都要编写对应测试 +- 定期进行代码审查 +- 关注性能指标和内存使用 +- 保持代码简洁和可读性 + +--- + +**记住：好的实现不仅要功能正确，更要易于维护和扩展！** \ No newline at end of file diff --git a/docs/实现细节规范.md b/docs/03-技术实现/实现细节规范.md similarity index 100% rename from docs/实现细节规范.md rename to docs/03-技术实现/实现细节规范.md diff --git a/docs/测试指南.md b/docs/03-技术实现/测试指南.md similarity index 100% rename from docs/测试指南.md rename to docs/03-技术实现/测试指南.md diff --git a/docs/网络管理器设置.md b/docs/03-技术实现/网络管理器设置.md similarity index 100% rename from docs/网络管理器设置.md rename to docs/03-技术实现/网络管理器设置.md diff --git a/docs/场景设计规范.md b/docs/04-高级开发/场景设计规范.md similarity index 100% rename from docs/场景设计规范.md rename to docs/04-高级开发/场景设计规范.md diff --git a/docs/性能优化指南.md b/docs/04-高级开发/性能优化指南.md similarity index 100% rename from docs/性能优化指南.md rename to docs/04-高级开发/性能优化指南.md diff --git a/docs/模块开发指南.md b/docs/04-高级开发/模块开发指南.md similarity index 100% rename from docs/模块开发指南.md rename to docs/04-高级开发/模块开发指南.md diff --git a/docs/Web部署指南.md b/docs/05-部署运维/Web部署指南.md similarity index 100% rename from docs/Web部署指南.md rename to docs/05-部署运维/Web部署指南.md diff --git a/docs/auth/表单验证规范.md b/docs/06-功能模块/auth/表单验证规范.md similarity index 100% rename from docs/auth/表单验证规范.md rename to docs/06-功能模块/auth/表单验证规范.md diff --git a/docs/auth/认证测试指南.md b/docs/06-功能模块/auth/认证测试指南.md similarity index 100% rename from docs/auth/认证测试指南.md rename to docs/06-功能模块/auth/认证测试指南.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..dffcec9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,177 @@ +# 📚 WhaleTown 项目文档导航 + +欢迎来到WhaleTown项目文档中心！本文档按开发阶段组织，帮助你快速找到所需的文档。 + +## 🗂️ 文档结构 + +``` +docs/ +├── 📖 README.md # 本导航文档 +├── 📁 01-项目入门/ # 新人必读，项目基础 +├── 📁 02-开发规范/ # 编码标准和规范 +├── 📁 03-技术实现/ # 具体开发指导 +├── 📁 04-高级开发/ # 进阶开发技巧 +├── 📁 05-部署运维/ # 发布和部署 +└── 📁 06-功能模块/ # 特定功能文档 +``` + +--- + +## 🚀 快速开始指南 + +### 👋 我是新人，从哪里开始？ +**推荐阅读顺序：** +1. [项目结构说明](01-项目入门/项目结构说明.md) - 了解项目架构 +2. [项目设置指南](01-项目入门/项目设置指南.md) - 配置开发环境 +3. [输入映射配置](01-项目入门/输入映射配置.md) - 设置游戏控制 +4. [命名规范](02-开发规范/命名规范.md) - 学习编码规范 + +### 💻 我要开始编码了 +**必读文档：** +- [架构与通信规范](02-开发规范/架构与通信规范.md) - 组件通信方式 +- [实现细节规范](03-技术实现/实现细节规范.md) - 具体实现要求 +- [开发哲学与最佳实践](02-开发规范/开发哲学与最佳实践.md) - 代码质量标准 + +### 🔧 我需要集成API +**相关文档：** +- [API接口文档](03-技术实现/API接口文档.md) - 接口说明 +- [网络管理器设置](03-技术实现/网络管理器设置.md) - 网络配置 +- [测试指南](03-技术实现/测试指南.md) - 测试方法 + +### 🚀 我要发布项目 +**部署文档：** +- [Web部署指南](05-部署运维/Web部署指南.md) - Web版本发布 + +--- + +## 📁 详细目录 + +### 01-项目入门 📖 +> **适用人群**: 新加入项目的开发者 +> **使用时机**: 项目开始前，环境搭建阶段 + +| 文档 | 用途 | 重要程度 | +|------|------|----------| +| [项目结构说明.md](01-项目入门/项目结构说明.md) | 了解项目整体架构和目录组织 | ⭐⭐⭐⭐⭐ | +| [项目设置指南.md](01-项目入门/项目设置指南.md) | Godot项目配置和AutoLoad设置 | ⭐⭐⭐⭐⭐ | +| [输入映射配置.md](01-项目入门/输入映射配置.md) | 游戏输入控制配置方法 | ⭐⭐⭐⭐ | + +### 02-开发规范 📋 +> **适用人群**: 所有开发者 +> **使用时机**: 编码过程中，代码审查时 + +| 文档 | 用途 | 重要程度 | +|------|------|----------| +| [命名规范.md](02-开发规范/命名规范.md) | 统一的命名标准 | ⭐⭐⭐⭐⭐ | +| [代码注释规范.md](02-开发规范/代码注释规范.md) | 注释格式和标准 | ⭐⭐⭐⭐ | +| [Git提交规范.md](02-开发规范/Git提交规范.md) | 版本控制规范 | ⭐⭐⭐⭐ | +| [架构与通信规范.md](02-开发规范/架构与通信规范.md) | 组件间通信标准 | ⭐⭐⭐⭐⭐ | +| [开发哲学与最佳实践.md](02-开发规范/开发哲学与最佳实践.md) | 代码质量和开发理念 | ⭐⭐⭐⭐ | + +### 03-技术实现 🔧 +> **适用人群**: 正在开发功能的程序员 +> **使用时机**: 具体功能开发时 + +| 文档 | 用途 | 重要程度 | +|------|------|----------| +| [实现细节规范.md](03-技术实现/实现细节规范.md) | 游戏对象具体实现要求 | ⭐⭐⭐⭐⭐ | +| [API接口文档.md](03-技术实现/API接口文档.md) | 后端接口说明和使用 | ⭐⭐⭐⭐⭐ | +| [网络管理器设置.md](03-技术实现/网络管理器设置.md) | 网络通信配置 | ⭐⭐⭐⭐ | +| [测试指南.md](03-技术实现/测试指南.md) | 测试方法和工具使用 | ⭐⭐⭐⭐ | + +### 04-高级开发 🚀 +> **适用人群**: 有经验的开发者，架构师 +> **使用时机**: 复杂功能开发，性能优化时 + +| 文档 | 用途 | 重要程度 | +|------|------|----------| +| [模块开发指南.md](04-高级开发/模块开发指南.md) | 创建可复用模块的方法 | ⭐⭐⭐ | +| [场景设计规范.md](04-高级开发/场景设计规范.md) | 场景架构和设计标准 | ⭐⭐⭐ | +| [性能优化指南.md](04-高级开发/性能优化指南.md) | 游戏性能优化策略 | ⭐⭐⭐ | + +### 05-部署运维 🌐 +> **适用人群**: DevOps工程师，项目负责人 +> **使用时机**: 项目发布，部署配置时 + +| 文档 | 用途 | 重要程度 | +|------|------|----------| +| [Web部署指南.md](05-部署运维/Web部署指南.md) | Web版本导出和部署 | ⭐⭐⭐⭐ | + +### 06-功能模块 🎮 +> **适用人群**: 开发特定功能的程序员 +> **使用时机**: 开发对应功能时 + +| 目录/文档 | 用途 | 重要程度 | +|-----------|------|----------| +| [auth/](06-功能模块/auth/) | 用户认证系统相关文档 | ⭐⭐⭐⭐ | +| └── [表单验证规范.md](06-功能模块/auth/表单验证规范.md) | 登录注册表单验证规则 | ⭐⭐⭐ | +| └── [认证测试指南.md](06-功能模块/auth/认证测试指南.md) | 认证功能测试方法 | ⭐⭐⭐ | + +--- + +## 🎯 按角色推荐 + +### 👨‍💻 前端开发者 +**必读**: 01-项目入门 → 02-开发规范 → 03-技术实现 +**选读**: 04-高级开发 → 06-功能模块 + +### 🏗️ 架构师/技术负责人 +**必读**: 01-项目入门 → 02-开发规范 → 04-高级开发 +**选读**: 03-技术实现 → 05-部署运维 + +### 🧪 测试工程师 +**必读**: 01-项目入门 → 03-技术实现/测试指南.md +**选读**: 06-功能模块 + +### 🚀 DevOps工程师 +**必读**: 01-项目入门 → 05-部署运维 +**选读**: 03-技术实现 + +--- + +## 🔍 快速查找 + +### 按问题类型查找 + +**🤔 "我不知道项目是怎么组织的"** +→ [项目结构说明.md](01-项目入门/项目结构说明.md) + +**🤔 "我不知道怎么命名变量/函数"** +→ [命名规范.md](02-开发规范/命名规范.md) + +**🤔 "我不知道怎么让组件之间通信"** +→ [架构与通信规范.md](02-开发规范/架构与通信规范.md) + +**🤔 "我不知道怎么实现玩家/NPC"** +→ [实现细节规范.md](03-技术实现/实现细节规范.md) + +**🤔 "我不知道怎么调用API"** +→ [API接口文档.md](03-技术实现/API接口文档.md) + +**🤔 "我不知道怎么测试功能"** +→ [测试指南.md](03-技术实现/测试指南.md) + +**🤔 "我不知道怎么发布项目"** +→ [Web部署指南.md](05-部署运维/Web部署指南.md) + +--- + +## 📝 文档维护 + +### 更新频率 +- **01-项目入门**: 项目架构变更时更新 +- **02-开发规范**: 团队规范调整时更新 +- **03-技术实现**: API变更或新功能时更新 +- **04-高级开发**: 最佳实践演进时更新 +- **05-部署运维**: 部署流程变更时更新 +- **06-功能模块**: 对应功能开发时更新 + +### 贡献指南 +如果你发现文档有问题或需要补充： +1. 创建Issue描述问题 +2. 提交PR修改文档 +3. 遵循[Git提交规范](02-开发规范/Git提交规范.md) + +--- + +**💡 提示**: 建议将本导航页面加入书签，方便随时查阅！ \ No newline at end of file