如何优雅地参加开源奉献,向顶级开源我的项目提交 PR(Pull Request)。战“码”先锋直播间第八期围绕“OpenAtom OpenHarmony(以下简称“OpenHarmony”)开源奉献”话题,邀请了深圳开鸿数字产业倒退有限公司(以下简称“深开鸿”)资深OS框架开发工程师巴延兴为大家带来《如何多方位参加OpenHarmony开源奉献》主题分享。
本次分享次要介绍了巴延兴率领深开鸿开源共建团队在主导/共建16个SIG、奉献超过50万行代码的OpenHarmony “战码”教训,在根技术、垂直畛域、生态扩大等多方位参加开源奉献的实际与思考,以及辅助工具SIG和内核SIG两大板块的奉献形式、价值与用处,心愿有更多开发者参加开源共建。
参加战“码”先锋,PR征集令!感兴趣的开发者能够在Gitee的OpenHarmony代码仓提交PR参加流动,和寰球开发者同台竞技,比拼技能,为OpenHarmony生态建设贡献力量。

如何通过SIG进行开源奉献

什么是SIG?
SIG全称Special Interest Group,即特地兴趣小组,专一一个特定的技术畛域,负责该畛域技术竞争力剖析和关键技术辨认及决策,引领技术演进的方向,也是共建单位及集体开发者进行开源奉献的根本单位。
通过SIG组参加开源共建的两种形式
一、参加到已有SIG的共建
参与者须要注册本人的官网账号,签订协议后,能力通过认领SIG leader公布的需要来承接共建工作。领完需要后是规范的开发过程,包含需要剖析、功能设计、代码开发、功能测试、性能交付等步骤;工作开发实现后,须要提交PR,将代码、文档等提交到社区,实现最终的开源奉献。
二、主导SIG组
1、成立SIG
选取共建技术畛域并给出布局 → 向PMC例会提交议题并通过评审 → 通过架构SIG例会评估后建设新的代码仓。
2、孵化SIG
启动需要廓清、个性梳理方案设计、代码开发、单元测试、功能测试等流程,实现SIG我的项目开发 → 对照Check List,实现法务、门禁、OAT等问题自检。
3、毕业SIG
向架构SIG申请新SIG毕业 → 向QA SIG会申请新SIG准出 → 仓库owner移仓。

辅助工具SIG实践经验分享

成立辅助工具SIG组的主旨是“升高重复劳动,进步工作效率,让业余的人做业余的事”。NAPI框架代码生成工具、IDL转换工具和开机动画工具都是围绕着这个主旨开发而成的。
一、NAPI框架代码生成工具
NAPI是规范设施上的JS API实现形式,实现了JS语言到框架C++层的调用,在OpenHarmony零碎中,APP调用是调用JS语言的接口函数,最终具体性能是用C++语言来实现。
NAPI存在三个开发痛点须要解决:
1、NAPI框架代码的反复率高:面对不同的JS接口,开发者要实现类似度高的框架代码。
2、NAPI框架的学习老本高:框架机制波及JavaScript、C++语言,以及编译脚本工具。
3、NAPI 需求量大:OpenHarmony零碎性能均是通过NAPI接口体现,目前曾经反对1万多个NAPI接口。
针对以上三个痛点,NAPI框架代码生成工具将C++ 、JavaScript接口类型转换等代码抽取公共模块,并且主动生成编译脚本。开发者应用工具主动生成NAPI框架代码,只需实现业务代码调用即可,防止了大量反复的工作。

二、IDL转换工具
OpenHarmony应用的是HDF驱动框架,驱动相应的硬件信息须要IDL文件来形容。
IDL存在两大开发痛点须要解决:
1 、HDI开发难度大:HDI开发者比拟相熟C语言,习惯在.h文件中定义HDI接口,而对于IDL文件构造、语法并不是很相熟,学习曲线绝对较长。
2、HDI工作量大:HDI接口是驱动对外提供服务的必要条件,各个子系统均波及,故HDI工作量较大。
针对以上痛点,深开鸿设计的IDL转换工具将开发者相熟的.h文件主动转换为idl文件,开发者只须要在头文件中定义本人的接口即可,工具主动实现.h头文件到IDL文件转换,开发者不须要关怀IDL语法,大大降低工作量。

三、开机动画工具
开机动画工具是咱们晚期针对OpenHarmony2.0版本存在的问题做的一个辅助工具。
OpenHarmony2.0版本在开机动画方面有两个问题:
1、OpenHarmony2.0版本开机动画只反对raw文件,不利于开发者在发行版和定制版进行间接展示。
2、因为产品的状态不一,对于不同的产品,其开机动画的需要也是不同。
通过开机动画辅助工具使以上两个问题失去了更好地解决:
1、开机动画工具反对图片集或者 mp4等多种文件生成开机动画,且反对设置开机动画的分辨率等操作,更加不便开机动画的制作。
2、做到一键生成开机动画文件,并且反对在 windows平台上查看其成果,不须要每次都去烧录到开发板上,大大降低了演示的工作量。

四、辅助工具SIG共建方向
目前深开鸿主导的辅助工具SIG组次要提供给开发者文档资料、测试用例和工具开发3个共建方向。
如果你善于文档编撰,那么能够参加到社区的文档奉献,撰写文档能够不须要有很强的开发能力。
如果你是测试人员,善于自动化测试,那么通过测试用例也能够参加到社区的建设。
另外也欢送各位开发者参加到各种工具的建设中来。SIG组的工具能够是独立的工具,也能够通过插件的形式集成到IDE开发软件中。

五、参加辅助工具SIG奉献的具体形式
1、提交问题单。无论是文档的bug、测试用例的bug、还是代码的bug,提交了问题单就是对社区做了奉献,那么辅助工具SIG组如何提交问题单呢?
首先找到对应的仓库并登录,例如https://gitee.com/openharmony...。
提交过程中要留神格局要求,必须写分明提单过程中问题呈现的条件,预期的后果和谬误的后果,问题的定位信息等,有了这些信息后,支付这个问题单的开发也不便定位问题。

登录找到想要认领的问题单的页面,在评论中表白出想要承接这个需要的志愿,SIG的负责人会定期跟踪这些问题单并做出回答。

2、认领需要后进行开发流程
领到一个需要后要进行失常的开发,外围分为以下6步:
①通常开发者曾经配置好配置码云账号、集体邮箱和签订DCO(签订DCO次要是保障贡献者原创),有了这些前置工作当前,咱们能够操作代码仓库进行需要的开发。
②Fork代码到私仓。
③克隆fork进去的仓库到本人的主机上。
④在本地开发代码开发和性能验证。
⑤开发结束后向官网原始仓提交Pull Request,提交代码后会触发门禁等惯例查看。
⑥如果这个sig组是你本人主导的,那么作为Committer,须要评审他人提交的代码,如果只是参加共建,提交完代码通过门禁就实现工作。

内核SIG参加共建教训

对于深开鸿内核SIG共建教训,上面将以文件系统的优化为实例向大家分享具体的奉献过程。
内核共建的方向比拟多,体系架构有各个硬件平台的移植,内核模块中功耗治理、工夫治理、任务调度、中断治理、文件系统、三方库相干的内核shell命令移植,目前深开鸿次要在文件系统和第三方库方面做社区共建。深开鸿心愿未来开展更多方向的优化工作,并向外提供具体场景下内核零碎移植计划。

littlefs文件系统的共建过程:
1、理解社区需要,社区目前对littlefs文件系统随机读写的速度不称心。
2、理解到社区文件系统对随机读写需要的前提下,对littlefs随机读写IO性能瓶颈进行剖析,找到能优化的代码点,采纳了“以空间换工夫”的思路。
3、采纳逐渐优化的思路,明确计划后和社区负责人沟通,失去了社区负责人认可后,开展具体的代码工作。

因为文件系统优化是一个比较复杂的过程,上面分享了一套社区共建流程。
1、从社区认领需要后,通过微信群的形式和社区负责人沟通并廓清需要。
2、从技术上剖析需要并制订优化计划,再次和社区负责人沟通,做计划探讨并失去认可。
3、具体任务开发,包含工作拆解、编码实现、测试,最初提交PR。

针对littlefs文件系统优化过程中批改波及到的相干文件,包含littlefs文件代码,也就是点c和点h文件;也有编译相干的文件,即.gn文件gni文件,之所以批改编译相干的文件是为了测试littlefs的优化后的代码,咱们团队减少了相干的测试用例,这些测试用例会调用内核文件系统的API,波及到这些编译相干的文件。

littlefs第三方库代码实现后提交到社区的过程
1、littlefs第三方库repository门路,并fork到用户仓库。
2、git clone用户仓到本地。
3、提交批改到用户仓。
4、点击提交PR。
5、填写PR单,PR单页须要依照既定模板填写,写分明原始需要,如何解决这个问题,怎么解决这个问题以及具体批改点。
6、在评论中增加“start build”点亮PR。这里有一个特地留神的点,须要在评论中是手动填写“start build”这2个英文单词,目标是触发后续的门禁检测。这是OpenHarmony社区比拟特地的一点,其它开源我的项目中所没有的。



欢送感兴趣的开发者多方位参加OpenHarmony开源奉献,成为OpenHarmony Contributor,也欢送各位提出贵重的意见,为OpenHarmony奉献一份力量。
参加战“码”先锋,PR 征集令!在Gitee的OpenHarmony代码仓提交PR参加流动,和寰球的开发者一起共建OpenHarmony的凋敝生态!

文章中波及的链接汇总:

NAPI框架代码生成工具代码仓地址:
https://gitee.com/openharmony...
IDL转换工具代码仓地址:
https://gitee.com/openharmony...
 开机动画工具代码仓地址:
https://gitee.com/openharmony...

转发原文到朋友圈,私信官网小助手,即可获取讲师演讲PPT
原文链接:https://mp.weixin.qq.com/s/ex...