创建:2021-08-29 @toulzx
修改:2021-08-30本篇主要介绍如何向本项目提交(PR)相关资料,以及相关注意事项。
本项目创立的初衷是方便同学们的期末复习,因此主要接受 考试试卷
、复习 PPT
、习题&解答
、课件
等。
我们也欢迎大家在各文件夹中通过 Markdown 文档提供 选课/考试攻略
。
请不要上传 电子版的书籍
,我们认为这侵犯了版权。
请不要上传 实验代码
,我们认为这些需要同学们自己进行摸索。
请不要上传超过 100M 的单个文件,因为本项目没有启用 git-lfs
。
PPT
、word
转换成 pdf
格式我们希望你能这么做,这不仅能方便读者预览与使用,同时,pdf
格式的文件更有利于保护作者的权益。以下给出推荐的转换方法:
PPT
、word
文件中,文件 -> 导出 -> .pdf
使用 扫描全能王网页版
使用软件 Adobe Acrobat
进行转换
你可能还需要对过大的 pdf
文件进行压缩:pdf压缩
例如,我们一般会将课件统一存放在 课件
文件夹下,将历年考试试卷统一存放在 试卷
文件夹下。
如果文件的命名方式不统一,请先统一同类文件的命名,特别需要注意的是,请使用 第1章-1-课程介绍
代替 第一章-1-课程介绍
,后者有时不能被按序排列。
如果你可以确定一份资料的创建时期(特别是针对试卷),我们推荐文件名中出现这样的字段:2021-2022-1
,这表示它来自 2021-2022 学年第 1 学期
。
这里有一份 README.md 文件样例
。
GitHub 全方位支持 Markdown 语法,最常见的是 repo 中的 README 文档。事实上,由于轻量、简洁易读、可融入 (X)HTML 的特性,Markdown 标记语言被广泛使用。它简单易学,如果你想了解更多有关 Markdown 的特点和语法,欢迎访问 markdown.cn
。
Pull Request
这里有一份不错的入门教程:git 学习 --GitHub 上如何进行 PR (Pull Request) 操作
你也可以参考以下的提示完成 PR
Fork
项目(页面右上角)。如果你曾经Fork
过,那么你应该点击右上角头像,在 your repositories
中找到这个的 repo。
如果你刚做完第 1 步,此时页面会自动跳转到 Fork
完成后对应的 repo 页面(此时页面左上角名称下方会出现 “forked from …” 字样)。
打开想要上传资料的文件夹,点击 Add file
-> Upload files
将想要上传的文件或文件夹拖入页面中央的方框内,等候上传完成。
填写 commit 内容,一般只需填写第一行,概况本次 commit
的主要内容,提交。
Pull Requests
(页面标题下方) -> New pull request
,你 commit
后 repo 的内容和主分支的差异会在此展示。
Create pull request
,并请清楚描述 PR 内容,格式可参考此 PR: 更新 JAVA 程序设计 (2021-08) #22
git
工具上传本地资料在完成 $ git commit
和 $ git push
后,参照上述 6、7.
如果你不熟悉如何 commit
或 push
,请通过在线上传的方式,或阅读学习:廖雪峰/ Git 教程