Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

49 lines (38 loc) · 3.48 KB

贡献方式

以下三种方式均可对本项目做出贡献,推荐程度 2 > 1 > 3:

  1. 提交 PR:

    1. Fork 本项目:点击右上角的 Fork 即可
    2. 若上传到已有文件夹:在 GitHub web 端打开对应文件夹,点击 Add file 上传文件或新建文件
    3. 若上传到新建文件夹:在 GitHub web 端打开任意文件夹,点击 Add file / Upload files,在浏览器地址栏中更改你想要新建的文件夹名称,然后回车,上传文件
    4. 提交 PR:点击 Contribute,Open pull request 发起 PR 即可

    有些朋友在提交 PR 的时候可能会注意到自己的 Fork 和我们的主分支有许多不同的 commit 。如果出现这种情况,可以考虑以下两种解决方案:

    1. 如果对 git 不太熟悉,建议(在备份完成后)先删除你的项目,重新 fork 、上传并重新提交 PR
    2. 如果对 git 及其工作原理较为熟悉(而且愿意花费时间和流量折腾),可以尝试在 fork 出的项目上进行 rebase 以消除与主分支在历史上的冲突
  2. 提 Issue:发起 Issue,在 Issue 中附加文件,由项目维护者进行添加

  3. 发邮件到 这里 联系项目维护者进行添加,注明“TJUCS”即可(可选择匿名贡献)

文件上传方式

  1. 不建议通过 git clone 方式先克隆再上传文件,因为这样会克隆下 .git 文件夹,导致实际文件夹大小达到 10 G 左右,甚至更多
  2. 如果您计划上传的单个文件不超过 25 M,建议通过 GitHub Web 端直接上传
  3. 如果您计划上传的单个文件超过 25 M,建议在对应 README.md 处附加文件的「阿里云盘」分享链接(点 此链接 注册可得 500 G 容量)
  4. 如果您觉得这几种方式比较繁琐,请参考上一部分第 3 条

贡献须知

  1. 每个课程对应一个文件夹(除体育、大学英语、文化素质选修等课程外),其命名格式为 课程代码_课程名称(“课程代码”以 教育教学信息管理系统 中的课程代码为准)
  2. 课程文件夹下应包括但不仅限于如下几个文件或文件夹:
    • 电子书:课程使用的教材
    • 习题解答:如果需要,可以添加教材对应的习题解答
    • 参考书(文件夹):供参考的电子书
    • 课件(文件夹):必需、有意义的课件
    • 试题(文件夹):历年考试试题(学期_科目简称[_备注]
    • 资料(文件夹):复习资料
    • 作业(文件夹):平时作业
    • 实验(文件夹):平时实验
    • README.md:课程简介及评价、教师评价、经验分享等,见 模版,按时间顺序排列不同学期的情况
  3. 除特殊情况外,不应上传普通讲义课件,因为每年老师都会发,而且常更新,参考旧课件没有意义
  4. 文件上传者应对文件的有效性、正确性和质量负责,请避免上传重复的、无效的、错误的或低质量的文件
  5. 文件上传者应修改文件名使其符合同目录下其他文件的排序方式
  6. 文件上传者应修改文件为适宜格式,如 ppt 文件应尽量上传为 pdf、压缩文件尽量使用 zip 格式等
  7. 禁止上传下列文件:
    • 反动、色情或其他违反中华人民共和国法律、法规的文件
    • 涉及机密的文件
    • 侵犯版权的文件