Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 5.53 KB

贡献方法.md

File metadata and controls

76 lines (53 loc) · 5.53 KB

🙌 贡献 | Contribution

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

电脑前的您请不要吝啬，您的作品一旦被合并至该仓库中，有可能会被无数学弟学妹仰慕。我们需要您的 PR！

如果您希望匿名贡献，可以 email 至本人邮箱[email protected]，注明邮件主题即可

或者直接联系本人QQ：3565989732

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

🔧 操作方法 | Operation method

由于本项目体积很大，建议采用在 Github Web端 直接上传的方式(当然也可以 git clone 下来在本地操作)，Web端具体操作如下：

  1. 首先 Fork 本项目，点击右上角的 Fork 按键即可，注意与最新的主分支保持一致；

    • 可以使用网页版 GitHub 中 Fetch & Merge 一键拉取最新的仓库并更新自己的分支

  2. 上传自己的笔记或资料，可能会有以下情况：

    • 上传文件到已有文件夹：打开对应文件夹，点击 Add file 按钮下的 Upload file，上传您的文件。
    • 上传文件到新文件夹：打开任意文件夹，点击 Add file 按钮下的 Upload file，把浏览器地址栏中文件夹名称改为您想要新建的文件夹名称，然后按下 回车，再上传您的文件。
    • 修改已有文件（如 README.md）：打开对应文件，点击右侧铅笔标志 Edit this file，修改后上传您的文件。

  3. 提交 Pull requests

    • 提交 PR：上传完文件到个人仓库之后，点击 Pull Request 即可。请留意一下项目的文件组织和命名规范。

对 Github Pull requests 不熟悉的同学，可以查阅如何参与开源项目中的流程

💡 目录组织与命名规范 | Directory organization and naming conventions

由于各专业开设的课程可能出现同一课程开设在不同学期的情况，为便于查找，此 repo 将公共课必修课以及各个专业专业课放在不同的目录下，具体基本按照以下形式组织，请各位同学提交时注意命名规范（文件名请一定不要有空格），便于大家及时找到您的作品或经验~

注：对于课程名字相同，但课程类型、授课、考试均不同的课程可以分别创建文件夹

  • 例如：人工智能数学基础作为人工智能专业的必修考试课，同时也作为其余专业的专业选修课，可在「人工智能」和「选修课程」下分别创建两个该课程目录便于查找
|──公共必修课/[专业]必修课
    └──[课程名字]
    │  │  README.md
    │  │
    │  └─课程复习资料
    │          [课程]-[授课学期]-复习讲座.pptx/pdf
    │          [课程]-[授课学期]-复习手册.md/pdf
    │          ......
    │  │
    │  └─课程学习资源
    │          ......
    │  └─课程实验指导
    │          [课程]-[授课学期]-实验指导书.pdf......
    │  └─课程练习题目
    │          [课程]-[授课学期]-模拟题/往年题等......
    ......
|──公共必修课/[专业]必修课

提交的命名格式为 [课程]-[授课学期]-(资料的名称).后缀（课程请使用全名，授课学期为20xx春/秋），依据您的资料类型放置至对应的目录下即可。

  • README.md：对于该课程的一些整体认知，比如课程难度、特点、期末考试难度、学习规划、可供参考的书籍等（学长学姐们的宝贵经验 ✖️ 血泪教训 ✔️），具体请按照此模板：课程说明模板。
  • 课程复习资料：主要包括金牌讲师团期末复习讲座的课件、复习手册、笔记等
  • 课程学习资源：金牌讲师团开箱手册、电子书（请留意可能存在的版权问题）、课件（建议先向教师获得授权后再上传）等
  • 课程实验指导：实验环境配置教程、实验思路等（不推荐上传与成绩考核相关的作业答案与实验代码）
  • 课程练习题目：金牌讲师团命制的期末模拟题、经过授权允许的往年试题等

此外，您也当然可以在对应文件夹下创建一个文件夹来包含一些同质化的内容，比如

  • 我是 2050 秋季学期上数据结构与算法的小Q，想在「数据结构与算法」中传一个自己的分章节笔记，即在「数据结构与算法」文件夹下新建文件夹 课程复习资料/数据结构与算法-2050秋-学习笔记-小Q/，然后往里面填充内容即可。
  • 而如果已经汇总为一个文件，可以直接上传课程复习资料/数据结构与算法-2050秋-学习笔记-小Q.md/pdf文件即可

如果是新开设的课程或者项目里暂时没有的课程，也欢迎大家积极创建~

不要求实名，可使用昵称，但文件路径命名一定要规范（特别是二进制文件，会使仓库记录变得臃肿），提交的 commit 建议简短、恰当地命名，否则可能被 reject！

🚨 警告 | Warning

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