如何優(yōu)雅地參與開源貢獻，向頂級開源項目提交 PR（Pull Request）。戰(zhàn)“碼”先鋒直播間第八期圍繞“OpenAtom OpenHarmony（以下簡稱“OpenHarmony”）開源貢獻”話題，邀請了深圳開鴻數(shù)字產(chǎn)業(yè)發(fā)展有限公司（以下簡稱“深開鴻”）資深OS框架開發(fā)工程師巴延興為大家?guī)怼度绾味喾轿粎⑴cOpenHarmony開源貢獻》主題分享。

本次分享主要介紹了巴延興帶領(lǐng)深開鴻開源共建團隊在主導(dǎo)/共建16個SIG、貢獻超過50萬行代碼的OpenHarmony “戰(zhàn)碼”經(jīng)驗，在根技術(shù)、垂直領(lǐng)域、生態(tài)擴展等多方位參與開源貢獻的實踐與思考，以及輔助工具SIG和內(nèi)核SIG兩大板塊的貢獻方式、價值與用途，希望有更多開發(fā)者參與開源共建。

參與戰(zhàn)“碼”先鋒，PR征集令！感興趣的開發(fā)者可以在Gitee的OpenHarmony代碼倉提交PR參與活動，和全球開發(fā)者同臺競技，比拼技藝，為OpenHarmony生態(tài)建設(shè)貢獻力量。

如何通過SIG進行開源貢獻

什么是SIG？ SIG全稱Special Interest Group，即特別興趣小組，專注一個特定的技術(shù)領(lǐng)域，負責(zé)該領(lǐng)域技術(shù)競爭力分析和關(guān)鍵技術(shù)識別及決策，引領(lǐng)技術(shù)演進的方向，也是共建單位及個人開發(fā)者進行開源貢獻的基本單位。 通過SIG組參與開源共建的兩種方式 一、參與到已有SIG的共建
參與者需要注冊自己的官方賬號，簽訂協(xié)議后，才能通過認領(lǐng)SIG leader發(fā)布的需求來承接共建任務(wù)。領(lǐng)完需求后是標準的開發(fā)過程，包括需求分析、功能設(shè)計、代碼開發(fā)、功能測試、功能交付等步驟；任務(wù)開發(fā)完成后，需要提交PR，將代碼、文檔等提交到社區(qū)，完成最終的開源貢獻。

二、主導(dǎo)SIG組

1、成立SIG

選取共建技術(shù)領(lǐng)域并給出規(guī)劃 → 向PMC例會提交議題并通過評審 → 通過架構(gòu)SIG例會評估后建立新的代碼倉。

2、孵化SIG

啟動需求澄清、特性梳理方案設(shè)計、代碼開發(fā)、單元測試、功能測試等流程，完成SIG項目開發(fā) → 對照Check List，完成法務(wù)、門禁、OAT等問題自檢。

3、畢業(yè)SIG

向架構(gòu)SIG申請新SIG畢業(yè) → 向QA SIG會申請新SIG準出 → 倉庫owner移倉。

輔助工具SIG實踐經(jīng)驗分享

成立輔助工具SIG組的宗旨是“降低重復(fù)勞動，提高工作效率，讓專業(yè)的人做專業(yè)的事”。NAPI框架代碼生成工具、IDL轉(zhuǎn)換工具和開機動畫工具都是圍繞著這個宗旨開發(fā)而成的。

一、NAPI框架代碼生成工具

NAPI是標準設(shè)備上的JS API實現(xiàn)方式，實現(xiàn)了JS語言到框架C++層的調(diào)用，在OpenHarmony系統(tǒng)中，APP調(diào)用是調(diào)用JS語言的接口函數(shù)，最終具體功能是用C++語言來實現(xiàn)。

NAPI存在三個開發(fā)痛點需要解決：

1、NAPI框架代碼的重復(fù)率高：面對不同的JS接口，開發(fā)者要實現(xiàn)相似度高的框架代碼。

2、NAPI框架的學(xué)習(xí)成本高：框架機制涉及JavaScript、C++語言，以及編譯腳本工具。

3、NAPI 需求量大：OpenHarmony系統(tǒng)功能均是通過NAPI接口體現(xiàn)，目前已經(jīng)支持1萬多個NAPI接口。

針對以上三個痛點，NAPI框架代碼生成工具將C++ 、JavaScript接口類型轉(zhuǎn)換等代碼抽取公共模塊，并且自動生成編譯腳本。開發(fā)者使用工具自動生成NAPI框架代碼，只需實現(xiàn)業(yè)務(wù)代碼調(diào)用即可，避免了大量重復(fù)的工作。

二、IDL轉(zhuǎn)換工具

OpenHarmony使用的是HDF驅(qū)動框架，驅(qū)動相應(yīng)的硬件信息需要IDL文件來描述。

IDL存在兩大開發(fā)痛點需要解決：

1 、HDI開發(fā)難度大：HDI開發(fā)者比較熟悉C語言，習(xí)慣在.h文件中定義HDI接口，而對于IDL文件結(jié)構(gòu)、語法并不是很熟悉，學(xué)習(xí)曲線相對較長。

2、HDI工作量大：HDI接口是驅(qū)動對外提供服務(wù)的必要條件，各個子系統(tǒng)均涉及，故HDI工作量較大。

針對以上痛點，深開鴻設(shè)計的IDL轉(zhuǎn)換工具將開發(fā)者熟悉的.h文件自動轉(zhuǎn)換為idl文件，開發(fā)者只需要在頭文件中定義自己的接口即可，工具自動實現(xiàn).h頭文件到IDL文件轉(zhuǎn)換，開發(fā)者不需要關(guān)心IDL語法，大大降低工作量。

三、開機動畫工具

開機動畫工具是我們早期針對OpenHarmony2.0版本存在的問題做的一個輔助工具。

OpenHarmony2.0版本在開機動畫方面有兩個問題：

1、OpenHarmony2.0版本開機動畫只支持raw文件，不利于開發(fā)者在發(fā)行版和定制版進行直接展現(xiàn)。

2、因為產(chǎn)品的形態(tài)不一，對于不同的產(chǎn)品，其開機動畫的需求也是不同。

通過開機動畫輔助工具使以上兩個問題得到了更好地解決：

1、開機動畫工具支持圖片集或者 mp4等多種文件生成開機動畫，且支持設(shè)置開機動畫的分辨率等操作，更加方便開機動畫的制作。

2、做到一鍵生成開機動畫文件，并且支持在 windows平臺上查看其效果，不需要每次都去燒錄到開發(fā)板上，大大降低了演示的工作量。

四、輔助工具SIG共建方向

目前深開鴻主導(dǎo)的輔助工具SIG組主要提供給開發(fā)者文檔資料、測試用例和工具開發(fā)3個共建方向。

如果你擅長文檔編撰，那么可以參與到社區(qū)的文檔貢獻，撰寫文檔可以不需要有很強的開發(fā)能力。

如果你是測試人員，擅長自動化測試，那么通過測試用例也可以參與到社區(qū)的建設(shè)。

另外也歡迎各位開發(fā)者參與到各種工具的建設(shè)中來。SIG組的工具可以是獨立的工具，也可以通過插件的方式集成到IDE開發(fā)軟件中。

五、參與輔助工具SIG貢獻的具體方式

1、提交問題單。無論是文檔的bug、測試用例的bug、還是代碼的bug，提交了問題單就是對社區(qū)做了貢獻，那么輔助工具SIG組如何提交問題單呢？

首先找到對應(yīng)的倉庫并登錄，例如https://gitee.com/openharmony/napi_generator/issues。

提交過程中要注意格式要求，必須寫清楚提單過程中問題出現(xiàn)的條件，預(yù)期的結(jié)果和錯誤的結(jié)果，問題的定位信息等，有了這些信息后，領(lǐng)取這個問題單的開發(fā)也方便定位問題。

登錄找到想要認領(lǐng)的問題單的頁面，在評論中表達出想要承接這個需求的意愿，SIG的負責(zé)人會定期跟蹤這些問題單并做出答復(fù)。

2、認領(lǐng)需求后進行開發(fā)流程

領(lǐng)到一個需求后要進行正常的開發(fā)，核心分為以下6步：

①通常開發(fā)者已經(jīng)配置好配置碼云賬號、個人郵箱和簽署DCO（簽署DCO主要是保證貢獻者原創(chuàng)），有了這些前置工作以后，我們可以操作代碼倉庫進行需求的開發(fā)。

②Fork代碼到私倉。

③克隆fork出來的倉庫到自己的主機上。

④在本地開發(fā)代碼開發(fā)和功能驗證。

⑤開發(fā)完畢后向官方原始倉提交Pull Request，提交代碼后會觸發(fā)門禁等常規(guī)檢查。

⑥如果這個sig組是你自己主導(dǎo)的，那么作為Committer，需要評審別人提交的代碼，如果只是參與共建，提交完代碼通過門禁就完成任務(wù)。

內(nèi)核SIG參與共建經(jīng)驗

關(guān)于深開鴻內(nèi)核SIG共建經(jīng)驗，下面將以文件系統(tǒng)的優(yōu)化為實例向大家分享具體的貢獻過程。

內(nèi)核共建的方向比較多，體系架構(gòu)有各個硬件平臺的移植，內(nèi)核模塊中功耗管理、時間管理、任務(wù)調(diào)度、中斷管理、文件系統(tǒng)、三方庫相關(guān)的內(nèi)核shell命令移植，目前深開鴻主要在文件系統(tǒng)和第三方庫方面做社區(qū)共建。深開鴻希望將來展開更多方向的優(yōu)化工作，并向外提供具體場景下內(nèi)核系統(tǒng)移植方案。

littlefs文件系統(tǒng)的共建過程：

1、了解社區(qū)需求，社區(qū)目前對littlefs文件系統(tǒng)隨機讀寫的速度不滿意。

2、了解到社區(qū)文件系統(tǒng)對隨機讀寫需求的前提下，對littlefs隨機讀寫IO性能瓶頸進行分析，找到能優(yōu)化的代碼點，采用了“以空間換時間”的思路。

3、采用逐步優(yōu)化的思路，明確方案后和社區(qū)負責(zé)人溝通，得到了社區(qū)負責(zé)人認可后，展開具體的代碼工作。

由于文件系統(tǒng)優(yōu)化是一個比較復(fù)雜的過程，下面分享了一套社區(qū)共建流程。

1、從社區(qū)認領(lǐng)需求后，通過微信群的方式和社區(qū)負責(zé)人溝通并澄清需求。

2、從技術(shù)上分析需求并制定優(yōu)化方案，再次和社區(qū)負責(zé)人溝通，做方案討論并得到認可。

3、具體任務(wù)開發(fā)，包括任務(wù)拆解、編碼實現(xiàn)、測試，最后提交PR。

針對littlefs文件系統(tǒng)優(yōu)化過程中修改涉及到的相關(guān)文件，包括littlefs文件代碼，也就是點c和點h文件；也有編譯相關(guān)的文件，即.gn文件gni文件，之所以修改編譯相關(guān)的文件是為了測試littlefs的優(yōu)化后的代碼，我們團隊增加了相關(guān)的測試用例，這些測試用例會調(diào)用內(nèi)核文件系統(tǒng)的API，涉及到這些編譯相關(guān)的文件。

littlefs第三方庫代碼完成后提交到社區(qū)的過程

1、littlefs第三方庫repository路徑，并fork到用戶倉庫。

2、git clone用戶倉到本地。

3、提交修改到用戶倉。

4、點擊提交PR。

5、填寫PR單，PR單頁需要按照既定模板填寫，寫清楚原始需求，如何解決這個問題，怎么解決這個問題以及具體修改點。

6、在評論中添加“start build”點亮PR。這里有一個特別注意的點，需要在評論中是手動填寫“start build”這2個英文單詞，目的是觸發(fā)后續(xù)的門禁檢測。這是OpenHarmony社區(qū)比較特別的一點，其它開源項目中所沒有的。

歡迎感興趣的開發(fā)者多方位參與OpenHarmony開源貢獻，成為OpenHarmony Contributor，也歡迎各位提出寶貴的意見，為OpenHarmony貢獻一份力量。

參與戰(zhàn)“碼”先鋒，PR 征集令！在Gitee的OpenHarmony代碼倉提交PR參與活動，和全球的開發(fā)者一起共建OpenHarmony的繁榮生態(tài)！

文章中涉及的鏈接匯總：

NAPI框架代碼生成工具代碼倉地址：

https://gitee.com/openharmony/napi_generator

IDL轉(zhuǎn)換工具代碼倉地址：

https://gitee.com/openharmony/drivers_hdf_core/tree/master/framework/tools/idl-gen

開機動畫工具代碼倉地址：

https://gitee.com/openharmony/graphic_graphic_2d/tree/master/frameworks/bootanimation/data/bootanimation_tool