贡献指南

欢迎贡献

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

EEStUdy-Place 是一个由浙江大学电气工程学院学生会学术部创建的学习资源共享平台。我们欢迎所有同学参与贡献，共同建设这个学习社区！

🚀 快速开始

如果你是第一次参与贡献，我们建议你查看“从0开始”贡献指南，帮助你理解网站是如何从0开始架构的，并帮助你快速上手。

这篇文章大致说明了如何在本地运行网站，如何按照规范修改并上传你的贡献内容。

如果你想要探索更多细节，可以阅读本网站文档。

Bash
# 克隆仓库
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 查看本地效果

📝 贡献指南

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

课程攻略与经验分享

课程学习心得：分享你的学习方法和经验
教师评价：不同教师的授课风格、给分情况等
考试经验：考试形式、复习策略、重点难点
课程笔记：PDF、Word、思维导图等格式的笔记

学习资源

教材推荐：推荐优质教材和参考资料
在线资源：有用的网站、视频教程、在线课程
工具软件：学习相关的软件和工具推荐

技术改进

网站功能：改进网站功能和用户体验
内容整理：优化文档结构和内容组织
错误修复：修复文档中的错误和问题

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

文档格式

课程攻略：优先使用 Markdown 格式，也接受 Word 格式
笔记分享：支持 PDF、图片、思维导图等多种格式
评论感想：格式不限，鼓励自由表达

内容规范

使用清晰、准确的语言
提供具体、实用的信息
保持客观、友善的态度
尊重他人，避免不当言论

格式建议

请参考我们的课程模板来了解标准格式，但不要被格式约束，畅所欲言~

🔄 贡献方式

方式一：邮件投稿

如果你想投稿课程攻略、学习心得、课程笔记等内容，请发送邮件至：

邮箱地址：eesuad_zju@163.com
邮件标题：[EEStudy投稿] 课程名称/内容类型
邮件内容：你的投稿内容

方式二：GitHub Pull Request

1. Fork 仓库

访问 EEStUdy-Place
点击右上角的 "Fork" 按钮
选择你的 GitHub 账号作为目标

2. 克隆到本地

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

3. 创建新分支

Bash
git checkout -b feature/课程名称-你的贡献类型

4. 进行修改并提交

Bash
# 添加你的修改
git add .

# 提交修改（请使用清晰的提交信息）
git commit -m "添加微积分学习心得和经验分享"

# 推送到你的分支
git push origin feature/课程名称-你的贡献类型

5. 创建 Pull Request

访问你 fork 的仓库页面
点击 "Compare & pull request" 按钮
填写 PR 标题和详细描述
点击 "Create pull request"

6. 等待审核

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

📋 提交规范

Commit 信息规范

请使用清晰、简洁的 commit 信息：

Bash
# 好的例子
git commit -m "添加微积分学习心得"
git commit -m "更新电路分析课程信息"
git commit -m "修复文档中的错别字"

# 避免的例子
git commit -m "更新"
git commit -m "修改"
git commit -m "fix"

📞 联系我们

如果你有任何问题或建议，欢迎通过以下方式联系我们：

邮箱：eesuad_zju@163.com
GitHub Issues：提交问题
QQ群：电气工程学院学生会学术部官方群

🙏 致谢

感谢所有为 EEStUdy-Place 做出贡献的同学！你们的努力让这个学习平台变得更加完善和有用。

更新频率

我们将定期更新投稿内容，通常每周处理一次新的贡献。感谢你的耐心等待！