Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.15 KB
Raw

☁️ 贡献方法

❤️ 贡献流程

  1. fork 本项目；
  2. clone 所 fork 到个人的仓库到本地；
  3. 将本仓库作为个人 fork 的本地仓库的 上游仓库 (git remote add upstream ...)；
  4. 在本地创建一个不同于主分支的新分支，并切换到新分支上；
  5. 开始你的文档贡献；
  6. 将新分支 push 到你的 fork 仓库中；
  7. 在 fork 的仓库里点击 pull request。

⚓ 标准

样例见 HMU，下附仓库目录结构的文字说明：

1. 根目录

  • README.md 叙述本仓库整体情况；
  • 本目录下放置一系列文件夹，每个文件夹以 “高校英文简写” 命名，如：SJTU、Tongji 等。

2. 高校目录

  • README.md 叙述该院校可供我系同学填报的院系与专业方向，简述近期该校录取学生的大致流程；
  • 本目录下放置一系列文件夹，每个文件夹以 “报名年份” 命名，如：2021（指 2018 级学生）、2022（指 2019 级学生）。

3. 年份目录

  • README.md 叙述该年度报名录取情况；
  • doc 文件夹放置该年度中比较重要的文档（尽可能上传文本文件）；
  • experience 文件夹放置该年度参与该校申请流程同学的经验贴。文件名：[GitHub 用户名]-[报名学院]-[报名专业]-[报名所属阶段]-[参与情况].md，如：skyleaworlder-迟学院-躺平学-九推-offer.md。

🛠️ 推荐使用

  • Visual Studio Code + markdownlint
  • 配合预览功能，登录 GitHub 直接修改需要修改的文件

⚠️ 注意

需要遵守以下约定：

  • 部分高校在学生确认参与夏令营、预推免前，需要学生签署具备与 “隐私保密协议” 存在相似效力的文件。参与该项目的学生 不能违背先前签署的协议，不能上传高校严禁上传至公开网络的资源。
  • 原则上禁止代发。如若代发经验贴，则需经著作权人许可，且与著作权人达成协议或约定。

本仓库使用者不应将资料用于商业用途。