跳转至

贡献代码参考标准

文件目录结构

实验课设代码
├─XXXX
│  ├─README.md
│  └─code
├─XXXX
│
...
  1. 你应该在实验课设代码(后续会改英文目录)下的一个子目录中进行贡献,该目录名应为一个课程(或子类名)
  2. 子目录中应有一个README.md描述该课程开源代码的结构。
  3. 建议将单独代码放置在code子文件夹中(项目请自行考虑,要在README.md中说明)

代码开源规范

我们鼓励符合下列情况的代码开源:

  • 添加该项目中还未涉及到的课程相关代码
  • 添加该项目中已有课程但未包括的实验代码
  • 优化已有代码(项目目录优化,代码重构)
  • 添加 Wiki 知识点对应的代码

由于需保证代码质量,非项目团队成员开源的代码请先通过 Issue 联系我们,提交 PR,经团队 Review 后我们会选择合适片段添加至仓库中。