相信每个CS人都有过这样的经历:拿到一个实验或课设没有头绪的时候,习惯性的去搜索引擎找有没有相关内容,可查到的东西充斥着CSDN的递归引用和复制都复制不明白的转载。好不容易找学长要了一份代码,可回头一看全班一半人都拿到了相同的拷贝。作为一个饱受CSDN折磨的CSer,我决定做点什么来改变这个现状。
- 如果你想自己动手只是苦于没有头绪:绝大部分的坑前人们都已经踩过,欢迎你从中吸取经验和思路。
- 如果你只想交个实验混过去拉倒:还想啥呢下载下来跑他娘的
- 项目以专业/学年/课程的方式组织目录结构,请根据你的需求到对应文件夹里寻找相关内容。
- 管理开源仓库是个非常繁琐的工作,不幸的是笔者并没有充裕的时间去人工核对大家提交的内容,因此,项目使用github工作流进行自动管理,并且不会对提交的内容进行审核。所以请不要尝试修改别人提交的内容,如果你在某份代码的基础上做了改进,请重新提交你自己的代码.
如果你发现有人搞破坏,请通过issues联系我们。
随着时间的推移,相信你也会有自己的技术积累,如果你也想为后来人留下一些有价值的内容,请参考以下步骤来参与到这个项目中:
-
fork本项目到你自己的github仓库
-
上传你的实验/课设/etc到对应的目录
- 文件夹请遵循[你的代号]_[实验名/课设名]规范进行命名,如
BD_计算机网络
- 良好的代码风格和注释能帮助其他人理解你的思路,当然,这不是硬性要求。
- 如果方便的话,请在对关键信息进行脱敏后附带你的实验报告。当然,这也不是硬性要求。
- 多人合作下修改同一个文件不可避免的会出现冲突,所以除非你明确知道自己在干什么,请不要尝试修改任何文件。
- 文件夹请遵循[你的代号]_[实验名/课设名]规范进行命名,如
-
向仓库中添加代码时,请按照以下步骤进行自检
- 是否包含不必要的中间产物或依赖文件,如CLion产生的cmake-build-debug文件夹或CMAKE产生的中间产物等,再比如杀千刀的node_modules和pyvenv。
- 如果你使用Python/JS等脚本语言,请提供必要的依赖说明如requirements.txt或package.lock.json等
- 一个好的解决思路是,在你的项目根目录下添加一个.gitignore文件,以避免git跟踪不必要的文件。你可以根据自己的实际情况编写,或者从这里寻找一个跟你的项目对应的模板。
- 是否包含不必要的图片、视频、etc.。
- 如果你提供了项目文档,那么文档中包含的图片就没必要再放到文件夹中。
- 讲解视频\演示等请务必务必不要添加。
- 程序中可能用到的图片请留下一个简单的文本文件进行说明,然后删掉他们。
- 如果提供了文档/报告,请尽可能降低文件大小
- 对于doc/docx文件,一个行之有效的办法是压缩文件中包含的图片。具体方法请自行搜索。
- 对于pdf文件,你可能需要通过在线压缩工具来降低文件大小。
- 对于markdown文件,尽可能使用图床之类的服务存储图片,文档中只保留URL即可。
总之,请尽可能确保你的单个项目文件夹大小不超过3M。如果你尽了最大努力还是不能将你的项目压缩到合适的大小,你也可以选择只保留代码和必要的文件,在项目中留下你的联系方式/其余资源的网盘地址/etc.
- 是否包含不必要的中间产物或依赖文件,如CLion产生的cmake-build-debug文件夹或CMAKE产生的中间产物等,再比如杀千刀的node_modules和pyvenv。
-
确认修改完毕后,通过你自己的仓库页面发起一个pull request。
- 当你尝试发起一个pr时可能会遇到其他人已经提交了修改,按照github提示先将修改合并到你自己的分支再尝试推送你的pr。
- 本项目已和百度达成深度合作,遇到不会的问题欢迎使用百度搜索进行查询(
- 当然你也可以在项目中提一个issue,maintainer会不定期查看(
-
如无意外,bot会自动将你的修改合并到主分支。
- 我可以把下载的内容发给其他人吗?
- 可以,项目遵循GPL3.0协议,你可以任意处置你获得的代码。当然,这也意味着你上传的代码也需要遵循相同的协议。
- 我不想提供说明文档/实验报告/代码注释可以吗?
- 可以,虽然笔者强烈建议你这样做,但你仍然可以自由选择是否提交上述内容。
- 我上传的代码可以自己删除吗?
- 不可以。因为分布式的管理模式下很难对单独的文件夹进行权限管理,无法保证每个人只能删除自己的内容。因此上传后的代码不允许删除,如果你存在顾虑,请三思而后行。
- 为什么上传文件时要进行自检?
- 首先,因为众所周知的原因(),国内访问GITHUB的速度异常之慢。如果整个仓库体积过大会导致下载/clone花费长的令人难以忍受的时间。
- 再者,GITHUB为每个组织提供的免费空间只有500M。这也就意味着如果不尽可能的压缩文件体积,只需要寥寥几个项目就会耗尽仓库容量,本项目也就失去了意义。(当然如果有富哥们愿意报销每个月4-10刀的费用那都可以商量)
- 我想参与这个项目的管理/我对这个项目有一些建议\意见/我想资助你们升级空间大小(
- 欢迎通过issue向我们提建议/反馈,你也可以通过邮件联系maintainers