Skip to content

贡献指南

欢迎您考虑为我们的项目做出贡献!您的参与对我们来说非常宝贵。 在开始之前,请确保您已经阅读并理解了本指南的内容,以便您的贡献能够顺利进行。

Issues 规范

  • 搜索现有问题:在提交新问题之前,请先搜索现有的问题列表,以确保您的问题尚未被其他人提出。

  • 清晰明确的描述:提交问题时,请尽量提供清晰、明确的描述,包括具体的现象、复现步骤、预期行为和实际结果,如果可能的话,请提供相关的截图或最小可复现的代码示例。

  • 版本信息:如果您的问题与特定版本相关,请提供相关的版本信息,包括项目版本号、操作系统版本、浏览器版本等。

Pull Request 规范

  • 请先fork一份到自己的项目下,不要直接在仓库下建分支。
  • commit信息要以type:描述信息的形式填写,例如fix: fix xx bug
    • type:必须是feat, fix, docs, style. refactor, perf, test, chore, revert, build其中的一个。
    • header:描述信息不要超过72个字符。
  • 确保PR是提交到对应的分支,而不是master分支。
    • 前端项目提交到web分支
    • 后端项目提交到server分支
    • 文档提交到doc分支
  • 如果是修复bug,请在PR中给出描述信息。

根据 MIT 许可证发布