Skip to content

贡献指南

如何贡献

我们欢迎所有形式的贡献，包括但不限于：

  • 提交 Bug 报告
  • 提出新功能建议
  • 改进文档
  • 提交代码修复
  • 优化性能

开发流程

  1. Fork 项目
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建 Pull Request

代码规范

前端代码规范

  • 使用 ESLint 和 Prettier 进行代码格式化
  • 遵循 Vue.js 风格指南
  • 使用 TypeScript 编写新代码
  • 编写单元测试

后端代码规范

  • 使用 Black 进行代码格式化
  • 使用 Flake8 进行代码检查
  • 编写详细的文档字符串
  • 编写单元测试

提交规范

提交信息格式： 

<type>(<scope>): <subject>

<body>

<footer>

类型（type）： - feat: 新功能 - fix: 修复 - docs: 文档 - style: 格式 - refactor: 重构 - test: 测试 - chore: 构建

文档规范

  • 使用 Markdown 格式
  • 保持文档简洁清晰
  • 及时更新文档
  • 添加必要的示例代码

测试规范

  • 编写单元测试
  • 编写集成测试
  • 保持测试覆盖率
  • 测试用例要具有可读性

发布流程

  1. 更新版本号
  2. 更新更新日志
  3. 创建发布标签
  4. 部署到生产环境

联系方式

如有问题，请通过以下方式联系我们： - 提交 Issue - 发送邮件 - 加入讨论组

感谢您的贡献！