Update Project.md
This commit is contained in:
parent
25676f0e6d
commit
49e27eb4d1
|
@ -2,31 +2,88 @@
|
|||
|
||||
**注意:目前还在施工中,以最终发布的版本为准**
|
||||
|
||||
## 事先规划
|
||||
## 目标
|
||||
|
||||
**一定要选择成熟、活跃的开源项目!** 什么叫成熟、活跃的开源项目?简单地说,通常应当具有如下标准:
|
||||
1. 最近半年内一直
|
||||
2.
|
||||
3. 由一个团队进行维护,存在较多的贡献者
|
||||
课程项目的首要目标是希望同学能够通过一学期的课程学习,最终**能够向开源项目做出自己的贡献**。
|
||||
|
||||
**一定要选择成熟、活跃的开源项目!**
|
||||
* 需要是具有一定质量水准的开源项目
|
||||
* 有证据能证明高质量、被很多人使用、贡献者多,等等
|
||||
* 自己建一个GitHub仓库,但是不满足上述质量水准,是不可以的
|
||||
|
||||
## 评分标准
|
||||
由于开源贡献过程的挑战性和不确定性,我们强烈建议在课程学习的过程中,尽早开始,并且对多个开源项目尝试做贡献。不管贡献最终是否被接收,都会纳入最终的考核标准中,还请多多尝试。
|
||||
|
||||
## 检查清单
|
||||
|
||||
本节列出一些完成此课程项目的注意点:
|
||||
|
||||
### 项目选择
|
||||
|
||||
* 是否选择了成熟、活跃的开源项目?
|
||||
* 是否能够配置好项目需要的开发环境?
|
||||
* 是否对这个项目有强烈的兴趣?
|
||||
* 是否对这个项目的相关领域、编程语言、技术栈比较熟悉?
|
||||
* 这个项目是否有完善的开源管理机制?
|
||||
|
||||
### 任务选择
|
||||
|
||||
* 这个项目是否有比较多的待解决issue?
|
||||
* 这个项目是否有比较多的good first issue?
|
||||
* 有没有自己作为项目的用户想要去解决的问题?
|
||||
* 这个项目对issue的管理机制如何?
|
||||
* 这个项目的贡献流程和要求如何?
|
||||
|
||||
## 参考资料
|
||||
|
||||
1. [https://opensource.guide/](https://opensource.guide/): 关于如何参与开源的各种指南
|
||||
2. [https://github.blog/2020-01-22-browse-good-first-issues-to-start-contributing-to-open-source/](https://github.blog/2020-01-22-browse-good-first-issues-to-start-contributing-to-open-source/): GitHub官方对good first issue功能的介绍
|
||||
3. [https://github.com/topics/good-first-issue](https://github.com/topics/good-first-issue): GitHub提供的good first issue主题页面
|
||||
4. [https://goodfirstissue.dev/](https://goodfirstissue.dev/): 一个列出有good first issue的GitHub项目的网站
|
||||
5. [https://gfibot.io/](https://gfibot.io/): 对一些GitHub项目推荐good first issue(来自我们实验室)
|
||||
|
||||
## 考核方式及评分标准
|
||||
|
||||
### 开题/中期/期末Presentation(每个5分,共15分)
|
||||
|
||||
能够按照要求作报告,且报告中包含了要求的所有内容,即得5分满分。如果存在内容欠缺,明显准备不充分的情况,酌情扣分。
|
||||
为了让我们能够跟踪进展和提供反馈,课程会安排三次presentation(开题/中期/期末),每次presentation的内容要求如下(对PPT模板和形式不做要求):
|
||||
|
||||
#### 开题Presentation
|
||||
|
||||
1. 计划贡献的开源项目及其基本情况
|
||||
2. 为什么选择这个/这些开源项目?这个/这些项目的哪些方面吸引到了你?你对这个/这些项目的了解情况如何?
|
||||
3. 计划去做什么任务/解决什么issue?
|
||||
|
||||
#### 中期Presentation
|
||||
|
||||
1. 选择的开源项目/任务
|
||||
2. 已进行的开发和交流活动
|
||||
3. 过程中遇到的事件、问题和收获
|
||||
4. 未来的计划
|
||||
|
||||
#### 期末Presentation
|
||||
|
||||
1. 选择的开源项目/任务
|
||||
2. 每一个贡献从提出到被接收/拒绝的过程,涉及的沟通过程和代码贡献
|
||||
3. 对开源参与的总结/思考
|
||||
4. 对课程的建议
|
||||
|
||||
对于每次presentation,能够按照要求作报告,且报告中包含了要求的所有内容,即得5分满分。如果存在内容欠缺,明显准备不充分的情况,酌情扣分。
|
||||
|
||||
请在presentation开始前,将ppt以邮件形式发送给助教(heh@pku.edu.cn),文件命名统一为`学号-姓名-开题/中期/期末Pre.pdf/pptx`(例如`2001111320-何昊-开题Pre.pptx`)。
|
||||
|
||||
### 期末报告(10分)
|
||||
|
||||
最终提交的PDF文件遵循报告格式,且包含了要求的所有内容,即得5分基本分,分配如下:
|
||||
在期末presentation结束后,还要求提交一个期末报告,作为整个开源参与过程和思考的一个正式记录,也是我们评分的重要参考之一。
|
||||
|
||||
报告要求使用LaTeX撰写,模板参见[Report/](Report/)文件夹,以PDF格式提交,详细要求参见报告模板。
|
||||
|
||||
最终提交的报告若遵循报告格式,且包含了要求的所有内容,即得5分基本分,分配如下:
|
||||
* 遵循要求的报告格式,1分。
|
||||
* 准确列出了所有的交互和贡献,1分。
|
||||
* 对自己的贡献过程的总结与反思,1分。
|
||||
* 对开源现状的思考,未来是否会继续参与开源?1分
|
||||
* 对开源现状的思考,未来是否会继续参与开源?1分。
|
||||
* 对课程的建议,1分。
|
||||
|
||||
余下5分将根据报告的表达清晰度、思考深度、认真程度等因素综合评判,会根据优秀率的情况进行适当调整。需要特别注意的是,**报告的长度不会成为评分的标准**,希望大家把功课主要放在做开源贡献本身,及对整个过程的总结和思考上,报告简明扼要,能够表达清楚意思即可。
|
||||
余下3分将根据报告的表达清晰度、思考深度、认真程度等因素综合评判,会根据优秀率的情况进行适当调整。需要特别注意的是,**报告的长度不会成为评分的标准**,希望大家把功课主要放在做开源贡献本身,及对整个过程的总结和思考上,报告简明扼要,能够表达清楚意思即可。
|
||||
|
||||
### 贡献质量(15分)
|
||||
|
||||
|
|
Loading…
Reference in New Issue