Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 4.2 KB

贡献方法.md

File metadata and controls

68 lines (41 loc) · 4.2 KB

贡献

Issue、PR、纠错、资料、选课/考试攻略,完全欢迎!来自大家的关注、维护和贡献,才是让这个攻略继续存在的动力~

如果希望匿名贡献,可以 email 至此邮箱,注明 "HITSZ-CS-GEEK" 即可:[email protected]

由于本仓库未启用 git-lfs,因此请不要上传单个超过 100M 的文件,否则 Commit 无效,Web端只适合 25M 以下小文件。

对于课程和教师的评价可写在对应课程的 readme.md 中,格式参见 评价模板

操作方法

由于本项目体积很大,故可以采用在 Github Web端 直接上传的方式,具体操作如下:

  1. 首先 Fork 本项目,点击右上角的 Fork 按键即可。

    • 上传文件到已有文件夹:打开对应文件夹,点击 Add file 按钮下的 Upload file,上传你的文件。
    • 上传文件到新文件夹:打开任意文件夹,点击 Add file 按钮下的 Upload file,把浏览器地址栏中文件夹名称改为你想要新建的文件夹名称,然后按下 回车,再上传你的文件。
    • 修改已有文件(如 readme.md):打开对应文件,点击右侧铅笔标志 Edit this file,修改后上传你的文件。
    • 提交 PR:上传完文件到个人仓库之后,点击 Pull Request 即可。请留意一下项目的文件组织。

    • 也可以直接附加在 Issue 中,由维护者进行添加。

比如我是 2050 年上数据结构的 anonym,想在「数据结构」中传一个自己的笔记,即在「数据结构」文件夹下新建文件夹 note/2050_anonym,然后往里面填东西即可。

(当然,欢迎往对应的 readme.md 里面放自己的 GitHub 对应仓库链接~)

路径命名

  • 课程攻略:readme.md

  • 电子版教材:ebook/[电子书标题_出版社].pdf (由于可能存在的版权问题,暂未加入)

  • 电子版课件:slide/[教学年份_教师姓名]/[xxx](建议先向教师获得授权后再上传)

  • 实验指导书 & 实验资料:lab/[教学年份(_学生姓名)]/exp1/[xxx]

  • 平时作业题 & 作业资料:hw/[教学年份_学生姓名]/

  • 笔记:note/[教学年份_学生姓名]/

  • 历年试卷:exam/

Tips:

  • 不推荐上传与成绩考核相关的作业答案与实验代码,但鼓励上传作业中的难题思路和大实验的代码思路。
    • 如:高数作业集答案 ❌ 作业集后的模拟题答案 ✔️
    • 如:C语言实验代码​ ❌ C语言实验附加题思路 ✔️
    • 如:数逻实验代码​ ❌ 数逻压轴实验思路 ✔️
  • 不要求实名,可使用昵称,但文件路径命名一定要规范(特别是二进制文件,会使仓库记录变得臃肿),提交的 commit 建议简短、恰当地命名,否则可能被 reject
  • 由于某些原因,现存试卷资源匮乏,欢迎上传回忆版试卷。

提醒

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

  1. 如果对 git 不太熟悉,建议(在备份完成后)先删除你先前 Fork 的项目,重新 Fork,上传并重新提交 PR。
  2. 如果对 git 及其工作原理较为熟悉(而且愿意花费时间和流量折腾),可以尝试在 Fork 出的项目上进行 Rebase 以消除与主分支在历史上的冲突。

警告

下列内容为不适合上传的内容。如果你认为缺少这些资料将会影响资源的完整性,请优先考虑放在校内资源平台,或联系你的教师并由教师发布。建议你撰写一个 readme.md 文档并放置一些链接或指引文字来帮助找到这些资源。

  • 盗版电子书/付费电子书
  • 盗版/破解版/绿色版付费软件及其安装包
  • 课程/教师主页上列出的内容(请在获得教师许可后上传)

如果你认为本仓库的一些文件侵犯了您的权益,请 向我们发送邮件 。我们将会从仓库中彻底清除这些文件。