如何优雅地参加开源奉献,向顶级开源我的项目提交 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…