announcement, ospp,

OSPP(开源之夏)指导手册 - 2021

Jiarui LI (李佳芮) Jiarui LI (李佳芮) Follow Jun 24, 2021 · 8 mins read
OSPP(开源之夏)指导手册 - 2021

开源软件供应链点亮计划-暑期 2021 的见面会在 ninetailskim的主持下圆满完成,关于开源软件供应链点亮计划的详细内容,详见 Wechaty Summer of Code 2021 Kickoff Meeting

开源软件供应链点亮计划组委会活动里程碑

agenda

注:所有通过结项考核的同学都会收到对应项目的全额奖金,项目是否评为优秀不影响奖金的发放。

组委会官方指南

Wechaty 社区工作

Wechaty 的项目 Issue 作为本次同学和导师通知的主要渠道,请所有同学在入选后,务必完成第一件事: 在项目清单 Issue 下面,把所有同学和导师需要完成的工作,以 checklist 的形式回复到 Issue 下面,方便后续同学和导师完成相关工作,完成后在 Comment 中打钩确认

Wechaty 社区秉持开源开放的的原则,所有会议记录、在线会议、阶段性报告等视频、文档资料都会对社区完全开放。对自己的视频、文档资料介意开放的同学,请谨慎考虑加入。

参与项目的同学和导师需要分别完成 日常工作阶段性工作

  • 日常工作
    • 学生每周在 issue 下回复进度报告
    • 导师每周在 issue 下根据学生的进度报告进行评分
  • 阶段性工作
    • 2021.7.15 期初报告
    • 2021.8.28 期中 Demo Day
    • 2021.8.30 期中报告
    • 2021.9.30 期末报告

以下是具体的要求、模板以及过往学生的内容参考

日常工作

日常工作以 OSPP 2020 的优秀学生突出贡献奖获得者江姗姗的周报告和导师总结为例,详见编写一个“每日一句”插件

报告模板

# [项目名称] 进度报告

日期:XXXX-XX-XX

## 本周完成的成果
1. XX 
1. XX

## 本周遇到的困难和需要配合的地方
1. XX

## 下周的开发计划和预计成果
1. XX

## 其他需要说明和同步的事项
1. XX

导师评分模板

# [项目名称] 导师评分

日期:XXXX-XX-XX

## 本周进度报告的评分
- [ ] 1: Deliverable not acceptable
- [ ] 2: Deliverable is below expectations
- [ ] 3: Deliverable is OK
- [ ] 4: Deliverable is above expectations
- [ ] 5: Deliverable is perfect

## 其他需要说明和同步的事项
XXX

阶段性工作

期初、期中和期末三篇报告要以博客的方式提交到[ wechaty.js.org Repo ]中,在提交报告之前,可以先阅读 Wechaty 社区规范, 至少了解下面内容:

  1. Wechaty 的介绍
  2. 社区沟通渠道
  3. 会议规范
  4. 博客发布规范
  5. Issue 发布规范
  6. PR 发布规范

尤其要注意的是在博客发布规范中详细的介绍了如何提交博客、如何在博客中嵌入视频等,在期中、期末报告中会用到。具体三篇报告的要求如下。

期初报告

学生开发者
1. 个人介绍

请将自己的介绍以 markdown 的方式提交到 wechaty.js.org Repo 的 jekyll/_contributors 目录下。

可以参考以下的开发者介绍内容编写页:

2. 期初报告
  • 标题: OSPP 2021-期初报告-你的标题
  • 文件名: 2021-XX-XX-ospp-plan-XX
  • 报告 category 为:project, ospp
  • 报告 tag 至少包括:summer-of-wechaty,summer-2021,ospp,ospp-2021,plan
  • 报告内容至少包括:
    • 项目名称
    • 合作者介绍
    • 导师
    • 项目介绍
    • 项目计划

提交PR时请注意:为这个 PR 打上 ospp 的标签,并在 PR 中填写自己项目的 GitHub Issue 链接,方便组委会进行审核。

3. OSPP 2020 学生期初报告参考:
社区导师

按照社区博客提交规范,对学生提交的博客进行审核,审核通过后,在 GitHub Approve 这个 PR,然后交由 Wechaty PMC 进行博客审核。注意,社区导师一定要提前、优先 Approve 自己同学的 PR。

期中报告

期中报告提交之前会有一个 OSPP 的 Mid-term Demo Day, 导师和学生会在线上进行期中汇报。提交的期中报告包括 Mid-term Demo Day 的视频和期中报告内容总结。点击这里查看暑期2020中期路演日(Mid-Term Demo Day)会议实况

学生开发者
1. 期中 Demo Day 视频

每位开发者需要进行中期的展示,视频将添加至博客、提交到组委会中,并剪辑成完成的路演日视频,向全社区展示,吸引更多的开发者参与到对应的项目中:

  • 提交3-5分钟的、有真人出镜(视频会议软件录制)的、基于PPT的展示。
  • 提交不限时长的、有真人出镜(视频会议软件录制)的 Live Code。

学生要在8月26日之前将视频链接回复在对应项目的 Github Issue 下面进行提交,视频由同学们直接上传到Youtube / B站中,并直接将视频的链接和将视频以iframe方式附在各个博客中:

  • 视频需要上传到 youtube 中,并联系 Huan 添加到 wechaty 的 playlist 中。
  • 考虑到国内用户,可以上传到 bilibili 或者腾讯视频中

可以参考去年优秀学生突出贡献奖获得者江姗姗的视频:

2. 期中报告

在8月30日前,以Pull Requests形式在wechaty.js.org Repo中提交博客。

  • 标题: OSPP 2021-期中报告-你的标题
  • 文件名: 2021-XX-XX-ospp-mid-term-XX
  • 报告 category 为:project, ospp
  • 报告 tag 至少包括:summer-of-wechaty,summer-2021,ospp,ospp-2021,mid-termospp
  • 报告内容至少包括:

提交PR时请注意:为这个 PR 打上 ospp 的标签,并在 PR 中填写自己项目的 GitHub Issue 链接,方便组委会进行审核。

可以完整复制本文对应的Markdown作为博客内容模板,但也可添加更多的补充信息。

[开源软件供应链点亮计划-暑期2021](https://summer.iscas.ac.cn)”(以下简称 暑期2021)是由中科院软件所与 openEuler 社区共同举办的一项面向高校学生的暑期活动。旨在鼓励在校学生积极参与开源软件的开发维护,促进国内优秀开源软件社区的蓬勃发展。活动联合各大开源社区,针对重要开源软件的开发与维护提供项目,并向全球高校学生开放报名。 学生可自主选择感兴趣的项目进行申请,并在中选后获得该软件资深维护者(社区导师)亲自指导的机会。 根据项目的难易程度和完成情况,参与者还可获取“开源软件供应链点亮计划-暑期2021”活动奖金和奖杯。

本项目 [项目名称] 系 暑期2021 支持的开源项目。

## [项目名称]信息

- 导师:[导师名称]  
- 学生:[学生名称]  
- 项目介绍:[Github Issue 链接,如 https://github.com/wechaty/summer/issues/74]  

- 项目名称:  
- 方案描述:  
- 时间规划:  

## 项目进度

- 已完成工作:  
  *根据原定方案和时间规划,描述当前已有的工作成果*  
- 遇到的问题及解决方案:   
  *可以侧重描述总结与心得*  
- 后续工作安排:  
  *描述是否需要调整工作计划等*  

## 项目成果

项目仓库: <https://github.com/XX/XX>  

### live coding视频:
 
{% include iframe.html src="视频链接" %}

### PPT展示视频:

{% include iframe.html src="视频链接" %}

### 项目PPT:

{% include iframe.html src="pdf链接" %}

## 联系我们

- 项目链接:[Github Issue 链接,如 https://github.com/wechaty/summer/issues/74]  
- 联系方式:
3. OSPP 2020 学生期中报告参考:
社区导师
1. “暑期2021”组委会评审报告

08月16日 - 08月22日期间,将评审报告在组委会的 Gitlab 上的 Issue 中提交,并配合组委会进行中期审核。

2. Wechaty 社区中期博客评审

在8月30日前以Pull Requests形式在 wechaty.js.org Repo 的学生对应博客下,补充评审结果的相关信息。

同时,按照社区博客提交规范,对学生提交的博客进行审核,审核通过后,在 GitHub Approve 这个 PR,然后交由 Wechaty PMC 进行博客审核。注意,社区导师一定要提前、优先 Approve 自己同学的 PR。

可以完整复制本文对应的Markdown作为博客内容模板,但也可添加更多的补充信息。

## 评审对象

- 评审内容:*中期报告|结项报告*
- 提交人:*学生姓名*

## 评审结果

- 项目完成度:*评价学生是否按照原定方案实施项目,以及完成情况如何*
- 学生参与度:*评价学生在项目实施过程中是否积极参与*
- 代码贡献量:*评价学生在该项目中,为开源项目贡献的代码量*
- 综合评价及建议:*总结性评价,并给出改进建议*
- 最终评审结果:“通过” 或者 “不通过” (“不通过” 意为着项目终止,且学生将无法获得相应的奖金)

期末报告

学生开发者
1. 期末视频
  • 视频需要上传到 youtube 中,并联系 Huan 添加到 wechaty 的 playlist 中。
  • 考虑到国内用户,可以上传到 bilibili 或者腾讯视频中

可以参考去年飞书项目参与学生,今年飞书项目导师范蕊的视频:

2. 期末报告
  • 标题: OSPP 2021-结项报告-你的标题
  • 文件名: 2021-XX-XX-ospp-final-XX
  • 报告 category 为:project, ospp
  • 报告 tag 至少包括:summer-of-wechaty,summer-2021,ospp,ospp-2021,final
  • 报告内容至少包括:
    • 项目信息
      • 项目名称
      • 方案描述
      • 时间规划
    • 项目总结
      • 项目成果
      • 期末汇报视频
      • 期末汇报 PPT
      • 遇到的问题及解决方案
    • 导师审核
      • 评审对象
      • 评审结果

提交PR时请注意:为这个 PR 打上 ospp 的标签,并在 PR 中填写自己项目的 GitHub Issue 链接,方便组委会进行审核。

3. OSPP 2020 学生期末报告参考:
社区导师
1. “暑期2021”组委会评审报告

10月1日 - 10月14日期间,将评审报告在组委会的 Gitlab 上的 Issue 中提交,并配合组委会进行结项审核。

2. Wechaty 社区期末博客评审

在10月14日前以Pull Requests形式在 wechaty.js.org Repo 的学生对应博客下,补充评审结果的相关信息。

同时,按照社区博客提交规范,对学生提交的博客进行审核,审核通过后,在 GitHub Approve 这个 PR,然后交由 Wechaty PMC 进行博客审核。注意,社区导师一定要提前、优先 Approve 自己同学的 PR。

可以完整复制本文对应的Markdown作为博客内容模板,但也可添加更多的补充信息。

## 评审对象

- 评审内容:*结项报告*
- 提交人:*学生姓名*

## 评审结果

- 项目完成度:*评价学生是否按照原定方案实施项目,以及完成情况如何*
- 学生参与度:*评价学生在项目实施过程中是否积极参与*
- 代码贡献量:*评价学生在该项目中,为开源项目贡献的代码量*
- 综合评价及建议:*总结性评价,并给出改进建议*
- 最终评审结果:“通过” 或者 “不通过” (“不通过” 意为着项目终止,且学生将无法获得相应的奖金)

OSPP 2020 更多内容介绍

OSPP Wechaty Org Admin 工作内容

工具包:

  1. 社区 Repo: https://github.com/wechaty/summer
  2. 社区通知 Issue:https://github.com/wechaty/summer/issues/筹备会中完成后确认的项目清单链接
  3. 社区微信群:Summer of Wechaty - SoW
  4. 社区 Org Admin 组委会群:Summer of Wechaty Org Admin SoW
  5. Wechaty Contributor 群:Wechaty Contributors
  6. 所有发布到 Wechaty 的博客需要打上如下标签:
    • ospp-admin
    • summer-202X (202X 改为当前的年份)
    • summer-of-wechaty
    • ospp
    • ospp-202X (202X 改为当前的年份)

0. 筹备会

  1. 向 Wechaty Contributor 群中发起号召,号召 Wechaty 的 Contributor 成为当年开源之夏的 Mentor,并让 Mentor 在 Wechaty Summer Of Code Repo 中以 Issue 的方式发布任务。
  2. 将所有有意向参加的 Mentor 邀请到 Wechaty OSPP 的官方微信群中: Summer of Wechaty - SoW
  3. 在收集完所有的 OSPP 项目后,并发布项目清单 Issue,当年所有的重要通知,都在此 Issue 下以回复的形式通知社区,参考 2021 年的项目清单:OSPP 项目通知 ( “暑期2021” )- 2021
  4. 筹备 OSPP 的报名和相关安排,至少参加(举办)一场会议,参考 2021 年的筹备会内容:
  5. 完成当年的 OSPP 指导手册,并发布博客,参考 OSPP(开源之夏)指导手册 - 2021
  6. 在项目清单 Issue 下面,把所有 Org Admin 需要完成的工作,以 checklist 的形式复制回复到 Issue 下面,方便后续 Wechaty Org Admin 完成相关工作,完成后在 Comment 中打钩确认

1. 期初见面会

  1. Summer of Wechaty Org Admin |SoW 群中和所有 Org Admin 确认期初见面会的时间,并给所有参与的 Org Admin 期初见面会的日历邀请。
  2. 组织导师和同学完成见面会,在 Meeting Notes 中创建见面会的会议,并引导同学完成注册,注意要填写姓名、一句话介绍和邮箱,一定要有邮箱!,参考 2021 年的会议信息: Kick off OSPP First Meeting with Students, 同时在见面会中向社区同步至少以下三项信息:
  3. 在 Wechaty OSPP 的官方微信群中 (Summer of Wechaty - SoW)发布公告,往届参与者也可以旁听期初见面会,了解当年项目。
  4. 把所有入选的同学邀请到 Wechaty OSPP 的官方微信群中: Summer of Wechaty - SoW
  5. 在期初见面会结束之后发布期初博客,参考 Wechaty Open Source Promotion Plan 2021 Kickoff Meeting
  6. 推进所有同学提交社区的期初报告博客,并在当年OSPP 项目通知的 issue 下面同步期初博客完成进度,参考 2021 年 OSPP 期初博客进度完成情况。同时可以在对应的微信群中向同学发起接龙。

2. 期中答辩(Mid-term Demo Day)

  1. Summer of Wechaty Org Admin |SoW 群中和所有 Org Admin 确认期中见面会的时间,并给所有参与的 Org Admin 期初见面会的日历邀请。
  2. 发布期中答辩通知,参考 Wechaty 社区期中答辩(Mid-term Demo Day)通知
  3. 要求同学录制期中答辩的视频,包括答辩视频Live Coding 两个视频,并将对应的 YouTube 链接和国内视频网站的链接回复在自己项目的 Issue 下面。
  4. 推进同学按时提交组委会要求的期中报告,并在 Wechaty OSPP 的官方微信群中 (Summer of Wechaty - SoW)发起接龙,已提交完报告的同学完成接龙,接龙内容参考:

     接龙
     『暑期2021中期学生报告提交确认』
    
     组委会要求 XX (时间) 之前提交报告。若同学未在截止日期前在系统内提交报告,该项目将被视为自动放弃,组委会将不再支持此项目。
    
     Wechaty OSPP'21 中期需提交内容包括:
     1、组委会要求提交的报告
     2、Wechaty社区要求提交的博客
    
     请各个项目的同学,在确认已经完成后,接龙确认。(同时更新对应的 GitHub Issue)
     例 姓名/项目简称/Issue#
    
  5. 推进导师按时在组委会要求的平台完成期中报告的审核,并在 Wechaty OSPP 的官方微信群中 (Summer of Wechaty - SoW)发起接龙,已提交完报告的导师完成接龙,接龙内容参考:

     #接龙
     『暑期2021中期导师审核完成确认』
    
     组委会要求 XX(时间)之前完成审核。若导师未在截止日期前在系统内完成评审,该项目将被视为自动放弃,组委会将不再支持此项目。
    
     请各个项目的 mentor ,在确认完成审核后,接龙确认。(同时更新对应的 GitHub Issue)
     例 姓名/项目简称/Issue#
    
  6. 推进所有同学提交社区的期中报告博客,并在当年OSPP 项目通知的 issue 下面同步期中博客完成进度,参考 2021 年 OSPP 期中博客进度完成情况
  7. 确认所有同学完成 Wechaty 社区要求的两个视频,并在 Wechaty OSPP 的官方微信群中 (Summer of Wechaty - SoW)发起接龙,已在 Issue 下回复完视频链接的同学完成接龙,接龙内容参考:

     #接龙
     『暑期2021中期 Demo Day 视频完成确认』
    
     [烟花]XX(时间)[烟花] 将会进行 Wechaty 的中期 Demo Day 展示,每个学生进行Wechaty的中期答辩。
    
     期中 Demo Day 视频需要2个视频:
     1. 期中汇报视频 (3-5分钟的、有真人出镜的、基于PPT的展示)
     2. Live Coding 视频(不限时长的、有真人出镜的 Live Coding)
    
     可以参考去年@范蕊 的视频:
     1. 答辩视频:https://www.bilibili.com/video/BV1n54y1U7Fn
     2. Live Coding: https://www.bilibili.com/video/BV1v54y1e7LM
    
     视频提交截止日期:
     [爆竹] XX(时间) [爆竹]
     请及时提交,或者会影响项目评分。
    
     各个项目的同学 ,在完成视频录制后,接龙确认。(同时将视频链接更新到对应的 GitHub Issue)
    
     1. 姓名/项目简介/Issue#
    
  8. 组织导师和同学完成期中答辩,在 Meeting Notes 中创建期中答辩会议,并引导同学完成注册,注意要填写姓名、一句话介绍和邮箱,一定要有邮箱!,参考 2021 年的会议信息: Wechaty OSPP(开源之夏) Midterm Demo Day, 同时在 Agenda 中列出每个同学的答辩内容,参考如下:
    • [同学姓名] 项目名称
      • 答辩视频:https://答辩视频链接
      • Live Coding 视频:https://在线 Live Coding视频链接
  9. 在期中答辩结束之后发布期中博客,参考 暑期2020中期路演日(Mid-Term Demo Day)

3. 期末结项答辩(Final-term Demo Day)

TBW

优秀项目评选

2020年,经过3个月的努力,最终151位同学通过了结项审核,同学们的结项报告及日常研发工作得到了社区及组委会的一致认可。从项目角度(项目完成质量、代码的可读性、文档的完整度使得项目具有可延续性)、社区角度(学生对社区的贡献度、完成项目对社区的重要性等)、学生角度(学生参与活动的进步程度和快速学习能力)、开源角度(学生展现出未来持续贡献开源的潜力和意愿)等多方面综合评审后,得出了暑期2020的最终奖项

  • Wechaty 社区的 @univerone (江姗姗) 同学荣获暑期2020的优秀学生突出贡献奖!
  • Wechaty 社区的 @kxz18 (孔详哲) 同学荣获暑期2020的优秀学生最具潜力奖!

今年,Wechaty 还会为特别优秀的同学和项目提供如下奖项:

  • Wechaty 优秀项目奖
  • 结项之后,优质项目将会被 merge 到 Wechaty 官方 org 下。

期待在2021年的夏天,你也能在3个月后,顺利通过结项审核,并赢得 OSPP 颁发的优秀奖励!

Join Newsletter
Get the latest news right in your inbox. We never spam!
Written by Jiarui LI (李佳芮) Follow
Co-Creator of Wechaty; 句子互动创始人 & CEO,微软人工智能最具价值专家 (AI MVP)