Skip to content

贡献指南 ​

欢迎为 Qoder 项目做出贡献!

贡献方式 ​

报告 Bug ​

  1. 搜索现有 issues
  2. 使用 Bug 报告模板
  3. 提供详细信息和重现步骤
  4. 添加相关标签

功能建议 ​

  1. 描述功能需求
  2. 说明使用场景
  3. 提供设计建议
  4. 讨论实现方案

代码贡献 ​

  1. Fork 项目仓库
  2. 创建功能分支
  3. 实现功能或修复
  4. 编写测试用例
  5. 提交 Pull Request

开发流程 ​

环境搭建 ​

bash
git clone https://github.com/shingle666/qoder.git
cd qoder
npm install
npm run dev

编码规范 ​

  • 遵循项目编码风格
  • 编写清晰的注释
  • 保持代码简洁
  • 使用有意义的变量名

测试要求 ​

  • 为新功能编写测试
  • 确保所有测试通过
  • 保持高测试覆盖率
  • 测试边界情况

文档更新 ​

  • 更新相关文档
  • 添加使用示例
  • 更新 CHANGELOG
  • 检查文档准确性

Pull Request 指南 ​

提交前检查 ​

  • [ ] 代码通过所有测试
  • [ ] 遵循编码规范
  • [ ] 更新相关文档
  • [ ] 添加必要的测试

PR 描述 ​

  • 清晰描述变更内容
  • 说明变更原因
  • 列出相关 issues
  • 添加测试截图(如适用)

社区规范 ​

行为准则 ​

  • 保持友好和尊重
  • 欢迎新手贡献者
  • 提供建设性反馈
  • 遵循开源精神

沟通渠道 ​

  • GitHub Issues:Bug 报告和功能请求
  • GitHub Discussions:一般讨论
  • 社区论坛:经验分享

📚 Qoder 中文学习指南 - 非官方文档站点 | 每天都有新发现 🎆