对于上传的文件,请自行判断其是否可以被公开,例如若想上传课件,需询问原授课老师的意向,未经允许不得上传
由于本仓库未启用lfs,请确保上传内容中不包含单个超过100M的文件,否则该次提交无法生效
本仓库中每个课程单独占有一个文件夹,在对应课程的文件夹下,最好按照以下规范提交相应的内容,以保证所有课程资料在存储逻辑形式上的统一(若无对应的路径,就自行依据提交内容的类别,创建对应文件夹),课程目录下的内容会被脚本自动识别后添加到对应课程攻略页面的文末资源列表内
-
课程根目录下
- 在
README.md内,按照模板规范添加攻略内容,或进行勘误等
- 在
-
课程
ebook/目录下- 以
书本名称_出版社.pdf命名,提交可公开的电子书 - 由于盗版电子书不合规,对于这类书你可以添加一个
书本名称_出版社.txt指出所需的电子书版本即可,而无需给出实际的电子书,以避免版权纠纷 - 对于大小超过100M的电子书,本仓库由于未开启
lfs无法接收,你可以类似地采用上面的替代方案
- 以
-
课程
slide/目录下- 创建对应教学年份的
20xx_对应教师/目录,在征得允许后,提交电子课件
- 创建对应教学年份的
-
课程
hw/目录下- 创建对应教学年份的
20xx_学生昵称/目录,提交个人的作业题目、参考答案,或提交指向个人代码仓库的链接文本文件 - 若存在公共的作业,例如微积分的
- 创建对应教学年份的
-
课程
lab/目录下- 创建对应教学年份的
20xx_学生昵称/目录,提交课程实验相关资料
- 创建对应教学年份的
-
课程
note/目录下- 创建对应教学年份的
20xx_学生昵称/目录,提交个人笔记,可以是一个文本链接指向你发布笔记的地方,也可以是原始笔记文件 - 若直接上传笔记,且笔记包含图片等附件资源的,则需将其存放在新建的
20xx_学生昵称/引用/目录下,并以正确的绝对路径(例如https://github.com/OpenFuTech/SCUT-FT-Guide/blob/main/.../xxx.png的形式)而非相对路径(相对路径连接的资源能在你本地被看到,但上传后无法在网页中被看到)对附件进行链接
- 创建对应教学年份的
-
课程
exam/目录下- 创建对应教学年份的
20xx/目录,提交试卷或回忆版试卷
- 创建对应教学年份的
若你发现个别目录下未按照上述规范进行文件组织,欢迎你将其更正并提交PR
本仓库中各课程的README.md文件内以Markdown进行书写,若不了解也没关系,参考以下模板案例即可(本仓库中各README.md文件均为写好的模板,你只需在对应标题下添加内容即可)
# 一、最高级标题1
## 1.1 二级标题1
### 1.1.1 三级标题1
这是一段话语,比如可以是一段引言,引出下面带有逻辑的阐释
- 子语句1,这会被渲染成一段缩进的文字,前面带个小圆点
- 孙语句1,再次缩进一层,树的深度加深一层
- 孙语句2,此处两个孙语句一般是对子语句1的分步说明
- 子语句2,这使得你的文字呈现树状的逻辑结构,能更清晰地阐述观点
## 1.2 二级标题2
# 二、最高级标题2
由于你只有该仓库的读权限,而不具有写权限,故需要首先Fork本项目,即通过点击本仓库右上角的Fork按键将其克隆至个人账号下得到一个同名仓库,对于该同名仓库你具有完整的读写权限,你只需要在该同名仓库下做你想要做的贡献即可
完成Fork后就需要按照欲贡献的内容对同名仓库进行修改(请遵循前文提到的命名规范),有以下两种修改方式可供选择
- 其一:在Github对应页面的Web端(例如这是我的Fork仓库)直接进行修改
- 上传文件到已有文件夹:打开对应文件夹,点击
Add file按钮下的Upload file,上传你的文件,或通过Create new file按钮创建可在线编辑的文本文件 - 上传文件到新的文件夹:打开任意文件夹,点击
Add file按钮下的Upload file,把浏览器地址栏中文件夹名称改为你想要新建的文件夹名称,然后按下回车,再上传你的文件 - 修改已有文本文件内容:打开对应文件,点击右侧铅笔标志
Edit this file进行修改,修改完成后进行提交 - 删除或重命名原有文件:网页端无法进行此操作,若有需求,请参考下面的第二种修改方法
- 上传文件到已有文件夹:打开对应文件夹,点击
- 其二:通过
git clone指令克隆完整项目到本地后进行修改(包括文件的删除和重命名等),并通过push等一系列指令提交到同名仓库完成修改,这需要具有一定的Git使用经验,愿意花费时间的同学可自行B站搜索或参考这篇博客
上传完文件到个人仓库之后,点击Contribute按钮即可创建Pull Request,按照Github的指示即可完成贡献,你的贡献将会由我们审核后合并入本攻略的主分支