跳转至

贡献指南

Quick Start

Bash
1
2
3
4
git clone https://github.com/ZJU-EESUAD/EEStUdy-Place.git
cd EEStUdy-Place
pip install -r requirements.txt
mkdocs serve

访问 http://127.0.0.1:8000 查看本地效果

贡献指南

重要的事说三遍：欢迎大家进行贡献！欢迎大家进行贡献！欢迎大家进行贡献！！！

欢迎有想法的同学进行投稿!

我们希望你的投稿格式为：

  • 如果为完整性的课程攻略，尽量为Markdown格式，其次可以考虑Word格式
  • 如果是评论与感想，形式不限
  • 我们也希望接收手写/电子笔记、思维导图等内容

但是请你不要被格式约束，畅所欲言~

我们将定期更新投稿内容~

投稿方式有：

邮件投稿

如果你想投稿你的课程攻略、学长学姐心得、课程笔记、思维导图等内容，请将你的投稿发送至 eesuad_zju@163.com ，邮件标题为 [EEStudy投稿] xxx ，邮件内容为你的投稿内容。

Pull Request

  1. Fork 本仓库到你的 GitHub 账号下

    • 点击右上角的 Fork 按钮
    • 选择你的 GitHub 账号作为目标

  2. 克隆你 fork 的仓库到本地

    Bash
    1
2
    git clone https://github.com/你的用户名/EEStUdy-Place.git
cd EEStUdy-Place

  3. 创建新的分支

    Bash
    1
    git checkout -b feature/xxx

  4. 进行修改并提交

    Bash
    1
2
3
    git add .
git commit -m "描述你的修改"
git push origin feature/xxx

  5. 创建 Pull Request

    • 访问你 fork 的仓库页面
    • 点击 "Pull Request" 按钮
    • 选择要合并的分支
    • 填写 PR 标题和描述
    • 点击 "Create Pull Request"

  6. 等待审核

    • 维护者会审核你的修改
    • 如果需要修改，请继续提交到同一分支
    • 合并后你可以删除该分支

注意事项：

  • 提交前请先同步上游仓库的最新代码
  • commit 信息请简洁明了地描述改动
  • 如果是文档贡献，请遵循现有的文档格式

评论