资料库贡献指南(简易)

一般的贡献流程是：

在github上fork仓库 -> git clone到本地 -> 创建分支 -> ...

如果只是给资料库传点往年卷，这样做有些不太方便的地方：

• 资料库的内容很多，不设置镜像或代理，git clone需要很长很长时间
• 只是做简单新增文件的操作，不需要在本地预览，就没必要clone到本地再push到仓库
• 需要熟悉git的操作

所以，这里提供一个仅在github网页端进行贡献、不需要git的简单教程

本文适用于给资料库上传文件的情况。如果要给网站贡献文档，还是建议clone到本地进行预览

准备

你需要：

• 能访问github的网络环境
• 一个github账号

如果无法访问github，可以试试 Steam++/Watt Toolkit 的github加速功能；或者自行配置clash

关于上传文件的命名/路径规范，请尽量遵循：

• 课件和作业：课程名称/开课时间/授课老师/(课件、作业)/两位数字-章节名称
• 往年卷：
  • 课程名称/试卷/(期中、期末)-(xxxx-xxxx学年第x学期)-(带答案、无答案、回忆版)
  • 课程名称/试卷/(期中、期末)-(xx级)-(带答案、无答案、回忆版)

特别是原先仓库中没有需要的文件路径，需要创建新文件夹时！

正篇

第一步：Fork仓库

• 打开资料库的github仓库链接repo
• 在右上角点击 Fork 创建自己的仓库副本
• 这里的相关信息保持默认即可。如果 Copy the main branch only 没有默认勾选上，可以勾选，只复制主分支

第二步：创建分支

• 打开自己fork的仓库页面
• 点击左上角分支下拉菜单（默认显示 main），在搜索框中输入一个新分支名，然后点击 Create branch <name> from main
• 在左上角分支下拉菜单，切换到刚刚创建的分支

分支名建议用有意义的名字，比如add-papers

第三步：上传和Commit

• 打开到你想要上传文件的对应路径
• 点击 Add file -> Upload files ，上传文件
• 然后填写标题和（可选）描述，比如：Add 高级程序设计 往年卷
• 点击 Commit changes ，之后应该会跳转回自己仓库的界面

一般来说，同类的新增文件共用一个commit。比如同时上传了高程和数字系统的试卷，可以分两个commit上传

第四步：发起Pull Request

• 在自己仓库的页面，切换到刚刚创建的分支，点击新出现的 Compare & Pull Request 的绿色选项
• 检查目标仓库/分支和源仓库/分支、所有改动的文件符合预期
• 填写标题和描述（写清楚改动文件清单、存放位置和来源等信息）
• 发起pr，之后只需要等待合并！

可能的问题

如果你需要创建新的文件夹（比如上传新增课程的资料）：

• 由于网页端不能直接创建文件夹，需要在本地创建好文件夹，上传时直接上传文件夹本体即可
• 新建的路径记得遵循命名规范：课程名称/开课时间/授课老师/(课件、作业)/两位数字-章节名称

如果fork过了很久，原仓库已经有了改动：

• 先去自己fork的仓库点击 Sync fork - Update branch 更新各个分支

如果你文件已经commit上传，但是想重命名：

• 在网页端一个个重命名修改很麻烦，而且每次修改都算作一次commit
• 在自己fork仓库的页面，按下 .（英文句号）键，会调出一个网页版vscode，在这里编辑即可
• 改动完成在左侧 Source Control 菜单，输入 Message 也就是commit标题，然后下拉菜单里选择 Commit & Push
• 不知道为什么有点卡