0
  • 聊天消息
  • 系統(tǒng)消息
  • 評論與回復(fù)
登錄后你可以
  • 下載海量資料
  • 學(xué)習(xí)在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會員中心
創(chuàng)作中心

完善資料讓更多小伙伴認(rèn)識你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

10分鐘快速掌握OpenHarmony社區(qū)貢獻新流程

OpenAtom OpenHarmony ? 來源:未知 ? 2023-06-20 21:10 ? 次閱讀

點擊藍(lán)字 ╳ 關(guān)注我們


開源項目 OpenHarmony
是每個人的 OpenHarmony

為提升Issue和PR(Pull Request)的處理效率,OpenAtom OpenHarmony(以下簡稱OpenHarmony)社區(qū)優(yōu)化了Issue和PR處理流程,新支持了一系列交互命令和狀態(tài)標(biāo)簽,用于明確處理階段和當(dāng)前處理責(zé)任人。社區(qū)CI Bot工具還提供了待辦事項提醒能力,并能自動處理超期無效Issue和PR。流程交互更加友好,基于交互提示,還可以獲知下一步需要如何操作。本文會對社區(qū)貢獻流程優(yōu)化點進行介紹,不管你是社區(qū)貢獻的專家還是初涉開源社區(qū)的新手,都有必要花幾分鐘快速熟悉下OpenHarmony社區(qū)貢獻流程的新優(yōu)化點。流程也在持續(xù)優(yōu)化中,如有變化,請以最新的為準(zhǔn)。
需要注意的是,流程優(yōu)化是為了輔助社區(qū)參與者提升效率,不會影響既有流程。如果不使用新支持的交互命令和狀態(tài)標(biāo)簽,也可以使用既有流程正常處理Issue和PR。但是,強烈推薦大家使用這些新優(yōu)化后的功能,這樣可以明確當(dāng)前處理責(zé)任人人,讓Issue和PR更及時地得到響應(yīng)處理。

1、新流程能解決什么問題

先回顧下社區(qū)Issue和PR處理時存在的問題痛點。經(jīng)常關(guān)注社區(qū)的開發(fā)者會注意到,社區(qū)待處理的Issue和PR數(shù)量多的時候,處理速度會變得緩慢。導(dǎo)致Issue和PR不能有效處理的原因主要有:從社區(qū)貢獻者一側(cè)來分析,社區(qū)Issue和PR未規(guī)范提交,比如Issue描述不規(guī)范,缺少詳細(xì)描述和驗證步驟等關(guān)鍵信息;PR門禁編譯失敗、格式檢測失敗、門禁檢查失敗,DCO失敗、未參考檢視意見修改等,這些因素都會導(dǎo)致請求無法被處理而不能被合入。從社區(qū)貢獻流程側(cè)來分析,社區(qū)Issue和PR處理流程也存在一些改進點,比如當(dāng)前缺少Issue責(zé)任人精準(zhǔn)分配;缺少機制分配PR檢視人,PR處理階段不清晰;缺少處理超期時的主動提醒功能等;對超期的Issue和PR,系統(tǒng)不能自動處理等。


OpenHarmony社區(qū)為解決上述問題,對Issue和PR處理流程進行了優(yōu)化,主要包含:


●標(biāo)記狀態(tài)標(biāo)簽,明確處理階段責(zé)任人

通過標(biāo)記狀態(tài)標(biāo)簽識別處理責(zé)任階段、明確處理人。如果Issue和PR提交不規(guī)范,會有狀態(tài)標(biāo)簽顯示當(dāng)前處理責(zé)任人為提交人;如果提交的PR通過門禁測試,等待審核檢視,當(dāng)前處理責(zé)任人為Committer;如果已分配檢視人員,當(dāng)前處理責(zé)任人就是代碼檢視人員等。


●主動提醒責(zé)任人處理待辦事項

CI Bot會發(fā)郵件每日提醒責(zé)任人處理名下的待辦事項。強烈建議社區(qū)貢獻者訂閱Issue和PR的狀態(tài)變化通知,這樣就會接收系統(tǒng)的自動提醒。


●超期問題自動處理

基于規(guī)則,對于一些可以自動處理的情況進行分析,進行自動化處理。比如,對于驗收中的Issue,如果長期未確認(rèn),系統(tǒng)會自動進行關(guān)閉;對于門禁未通過等情況導(dǎo)致不符合合入標(biāo)準(zhǔn)的PR,超過一定時間,也會自動關(guān)閉。


OpenHarmony社區(qū)通過這些流程優(yōu)化來提升Issue和PR處理效率,下文會詳細(xì)介紹流程的優(yōu)化點和具體使用方法。


2、新流程介紹

以PR提交與審核流程為例,如圖1所示,我們按狀態(tài)標(biāo)簽進行講解,開發(fā)者們也可以參考

https://gitee.com/openharmony/community/blob/master/zh/infrastructure/build_command.md


圖1 PR審核處理流程圖

2.1 Waiting_On_Author狀態(tài)標(biāo)簽

PR提交人(社區(qū)貢獻者)創(chuàng)建PR后,PR的標(biāo)簽為Waiting_On_Author,表示當(dāng)前的責(zé)任人為PR提交人。CI Bot會提醒PR提交人及時處理該PR。如果PR提交人長時期未處理該PR,CI Bot會進行自動關(guān)閉。

如果PR提交人觸發(fā)門禁構(gòu)建,構(gòu)建失敗后,PR的標(biāo)簽依舊為Waiting_On_Author狀態(tài)。如果檢視人員或Committer審核人員提交了檢視意見,需要社區(qū)貢獻者去查看、修復(fù),PR的標(biāo)簽會被標(biāo)記為Waiting_On_Author狀態(tài)。


2.2 Waiting_For_Review狀態(tài)標(biāo)簽

當(dāng)PR提交人評論命令start build(倉庫配置門禁時使用該命令,如果未配置門禁,請使用code review命令),并且門禁構(gòu)建成功后,PR的狀態(tài)標(biāo)簽替代為Waiting_For_Review狀態(tài),表示當(dāng)前的責(zé)任人為Committer審核人員,需要由Committer分配檢視人員。CI Bot可以每日郵件定時提醒待辦事項,催促Committer分配檢視人員。


2.3 Reviewing狀態(tài)標(biāo)簽

Committer可以通過命令assign [@gitee_id1 @gitee_id2...]分配檢視人員。使用該命令時,Committer可以通過空格分隔來指定多個檢視人員;如果命令中不指定gitee_id,Committer則安排自己為檢視人員。分配檢視人員后,PR的狀態(tài)標(biāo)簽變換為Reviewing狀態(tài),表示當(dāng)前的責(zé)任人為代碼檢視人員。

分配的檢視人員需參與檢視,給出檢視意見,然后評論命令check comment提醒PR提交人處理;無檢視意見時,評論命令lgtm,提醒Committer審核處理。


2.4 Waiting_For_Merge狀態(tài)標(biāo)簽

當(dāng)所有檢視人員均對分配的PR沒有檢視意見時,并在PR評論區(qū)評論命令lgtm后,CI Bot會提醒Committer去審核該PR。此時,PR的狀態(tài)標(biāo)簽變換為Waiting_For_Merge狀態(tài)。


2.5 Merged 狀態(tài)標(biāo)簽

對于Waiting_For_Merge狀態(tài)標(biāo)簽的PR, 當(dāng)Committer審核通過后,PR的狀態(tài)標(biāo)簽會自動變換為Merged狀態(tài),表示該PR成功合入。


3、流程處理實例講解

本節(jié)以Pull Request處理流程為例,按處理階段分別進行講解。


3.1 提交修改Pull Request

當(dāng)PR提交人提交一個PR后,CI Bot會自動評論,如下圖所示。根據(jù)提示,如果代碼已經(jīng)開發(fā)完畢,PR提交人在PR評論區(qū)評論start build來觸發(fā)門禁。在觸發(fā)門禁前狀態(tài)標(biāo)簽為Waiting_On_Author,當(dāng)前的處理責(zé)任人為PR提交人。

圖2 新PR交互截圖

如果審核檢視人員為PR提交檢視建議后,PR的狀態(tài)標(biāo)簽變?yōu)閃aiting_On_Author,需要PR提交人處理建議,優(yōu)化修復(fù)提交的代碼。當(dāng)處理完畢,重新推送代碼后,需要重新觸發(fā)門禁。

注意:如果代碼倉沒有配置門禁,提示的內(nèi)容稍有不同,需要評論的命令是code view。


3.2 門禁構(gòu)建

在門禁通過后,PR的狀態(tài)標(biāo)簽會替換為Waiting_For_Review狀態(tài),如下圖所示。此后,該PR的處理責(zé)任人為代碼倉的Committer。Committer會負(fù)責(zé)分配檢視人員或者審核該PR。


圖3 門禁構(gòu)建成功截圖

3.3 代碼檢視

當(dāng)一個PR處于Waiting_For_Review狀態(tài)時,Committer可以使用assign命令分配給檢視人員進行檢視,如下圖所示。命令assign的具體用法,可以參考上一小節(jié)圖片中的操作提示。當(dāng)分配完畢檢視人員,PR的狀態(tài)標(biāo)簽會替換為Reviewing狀態(tài),當(dāng)前的處理責(zé)任人為分配的檢視人員。


圖4分配檢視人員截圖

如果檢視人員發(fā)現(xiàn)檢視的PR存在問題,提出檢視意見后,需要評論下check comment通知PR提交人根據(jù)檢視意見進行修改。PR的狀態(tài)標(biāo)簽會替代為Waiting_On_Author狀態(tài),當(dāng)前的處理責(zé)任人為PR提交人。


圖5提醒處理檢視意見截圖

如果PR不存在問題,檢視人員認(rèn)為可以合入,需要評論下lgtm(即:look good to me)通知Committer審核合入該PR。PR的狀態(tài)標(biāo)簽會替代為Waiting_For_Merge狀態(tài),當(dāng)前的處理責(zé)任人為Committer。


圖6提醒審核合入截圖

3.4 審核合入
當(dāng)代碼倉Committer認(rèn)為PR滿足合入要求,審核通過后,PR會被合入,此時PR的狀態(tài)標(biāo)簽會替代為Merged狀態(tài),則PR成功被合入。

圖7審核合入截圖

4、CI Bot待辦提醒

通過狀態(tài)標(biāo)簽識別當(dāng)前處理責(zé)任人后,就可以獲取責(zé)任人的待辦事項。通過記錄打標(biāo)簽的開始時間,就可以計算當(dāng)前處理階段停留時間,從而可以發(fā)郵件提醒及時處理待辦事項,并能自動化處理超期無效的Issue和PR。發(fā)郵件功能可以自行選擇是否訂閱。

4.1 每日待辦提醒
如果你在社區(qū)有待辦事項,社區(qū)會自動匯總并自動發(fā)郵件給你,提醒你及時處理。如果不想收到郵件,可以取消訂閱。但強烈推薦你保持訂閱,可以及時收到在社區(qū)的待辦事項。下圖為收到的待辦事項郵件示例。

圖8 待辦事項郵件截圖

4.2 自動超期處理
對于PR,審核檢視人員需要及時響應(yīng)處理;PR提交人也需要及時響應(yīng)反饋的檢視意見,如果長期未響應(yīng),不符合合入標(biāo)準(zhǔn)的PR,會在30天后被自動關(guān)閉。這樣做是為了保持一個干凈的社區(qū)貢獻環(huán)境,也不用擔(dān)心丟失代碼,被關(guān)閉的PR也可以很容易被PR提交人重新打開。對于Issue,如果社區(qū)審核人員認(rèn)為需要補充信息,或不能算做問題,以及需要Issue驗收確認(rèn)時,如果Issue提交人30天未響應(yīng),也會被自動關(guān)閉處理。在關(guān)閉之前,系統(tǒng)會發(fā)送提醒。請保持關(guān)注Issue和PR的變更信息。如下圖所示:

圖9 自動超期處理截圖

5、小結(jié)

本文對OpenHarmony社區(qū)貢獻流程優(yōu)化點進行了介紹,包含新支持的一系列交互命令和狀態(tài)標(biāo)簽,以及CI Bot的每日待辦事項郵件、自動超期處理等。如有疑問,歡迎隨時來社區(qū)反饋。




原文標(biāo)題:10分鐘快速掌握OpenHarmony社區(qū)貢獻新流程

文章出處:【微信公眾號:OpenAtom OpenHarmony】歡迎添加關(guān)注!文章轉(zhuǎn)載請注明出處。

聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學(xué)習(xí)之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請聯(lián)系本站處理。 舉報投訴
  • 鴻蒙
    +關(guān)注

    關(guān)注

    57

    文章

    2358

    瀏覽量

    42876
  • OpenHarmony
    +關(guān)注

    關(guān)注

    25

    文章

    3723

    瀏覽量

    16343

原文標(biāo)題:10分鐘快速掌握OpenHarmony社區(qū)貢獻新流程

文章出處:【微信號:gh_e4f28cfa3159,微信公眾號:OpenAtom OpenHarmony】歡迎添加關(guān)注!文章轉(zhuǎn)載請注明出處。

收藏 人收藏

    評論

    相關(guān)推薦

    軟通動力榮膺“openGauss社區(qū)突出貢獻單位”

    ,匯聚思想引領(lǐng)者、商業(yè)精英、技術(shù)專家、合作伙伴以及全球開源基金會等業(yè)界同仁,凝聚全國乃至全球產(chǎn)業(yè)發(fā)展力量,共同探討數(shù)據(jù)庫產(chǎn)業(yè)發(fā)展方向和未來機遇。 軟通動力作為openGauss的重要參與者和貢獻者,在大會中榮膺“2024年度openGauss社區(qū)突出
    的頭像 發(fā)表于 12-27 18:47 ?324次閱讀

    OpenHarmony人才生態(tài)大會南向生態(tài)社區(qū)發(fā)展論壇在武漢圓滿舉辦

    11月27日,OpenHarmony人才生態(tài)大會2024在武漢隆重舉行。當(dāng)日下午的 OpenHarmony南向生態(tài)社區(qū)發(fā)展論壇(以下簡稱“論壇”)上,眾多社區(qū)伙伴、企業(yè)代表、技術(shù)專家與
    的頭像 發(fā)表于 11-29 10:06 ?185次閱讀
    <b class='flag-5'>OpenHarmony</b>人才生態(tài)大會南向生態(tài)<b class='flag-5'>社區(qū)</b>發(fā)展論壇在武漢圓滿舉辦

    OpenHarmony人才生態(tài)大會南向生態(tài)社區(qū)發(fā)展論壇在武漢圓滿舉辦

    社區(qū)籌備成立Gateway SIG,將貢獻基于OpenHarmony的IoT設(shè)備基礎(chǔ)系統(tǒng)代碼,面向生態(tài)伙伴全面開放相關(guān)能力。 (中國移動智慧家庭運營中心家庭IoT產(chǎn)品部副總經(jīng)理施超) 還有多位行業(yè)
    發(fā)表于 11-29 09:54

    星光璀璨,聆聽 OpenHarmony 貢獻者之聲

    在第三屆開放原子開源基金會OpenHarmony技術(shù)大會上, 我們滿懷敬意地對取得優(yōu)秀成果的星光OpenHarmony技術(shù)俱樂部、星光導(dǎo)師、星光貢獻者、星光活動進行了致謝。 他們不僅是技術(shù)的探索者
    發(fā)表于 10-28 17:09

    第三屆OpenHarmony技術(shù)大會星光璀璨、致謝OpenHarmony社區(qū)貢獻

    (技術(shù)專家組)、TSG星光貢獻者和星光OpenHarmony技術(shù)俱樂部、星光導(dǎo)師、星光貢獻者、星光活動等OpenHarmony社區(qū)
    的頭像 發(fā)表于 10-21 14:10 ?226次閱讀

    第三屆OpenHarmony技術(shù)大會在上海成功舉辦

    最新的生態(tài)進展。據(jù)龔體介紹,開源四年以來,OpenHarmony社區(qū)匯聚了超過8000名貢獻者以及70多家共建單位,累計產(chǎn)出1.1億多行代碼,超過780款軟硬件產(chǎn)品通過兼容性測評,覆蓋金融、超高清、教育
    發(fā)表于 10-13 11:14

    鴻蒙OpenHarmony南向/北向快速開發(fā)教程-迅為RK3568開發(fā)板

    優(yōu)化開發(fā)流程-配置遠(yuǎn)程訪問環(huán)境 P8_優(yōu)化開發(fā)流程-編譯源碼和燒寫鏡像 P9_OpenHarmony源碼目錄介紹 P10_整體移植方案介紹 P11_編譯目標(biāo)分析 P12_編譯框架基本概
    發(fā)表于 07-23 10:44

    400萬!深開鴻OpenHarmony主倉代碼貢獻量再創(chuàng)里程碑!

    2024年7月8日,據(jù)OpenAtomOpenHarmony(以下簡稱“OpenHarmony”)官網(wǎng)顯示,深開鴻在OpenHarmony社區(qū)主倉代碼
    的頭像 發(fā)表于 07-09 08:33 ?360次閱讀
    400萬!深開鴻<b class='flag-5'>OpenHarmony</b>主倉代碼<b class='flag-5'>貢獻</b>量再創(chuàng)里程碑!

    報名開啟!第二屆OpenHarmony開發(fā)者大會2024重磅來襲!

    論壇”為承載,聚焦OpenHarmony 技術(shù)革新,攜手百位技術(shù)專家共同交流開發(fā)者關(guān)心的技術(shù)內(nèi)容,全方位了解最新技術(shù)進展。 OpenHarmony開源三年多以來,社區(qū)
    發(fā)表于 05-14 15:23

    深開鴻升為OpenHarmony項目群A類捐贈人,引領(lǐng)開源生態(tài)新篇章!

    近日,深開鴻作為OpenHarmony核心共建單位、OpenHarmony生態(tài)委員會委員單位、OpenHarmony代碼Top10貢獻單位,
    的頭像 發(fā)表于 04-18 08:33 ?826次閱讀
    深開鴻升為<b class='flag-5'>OpenHarmony</b>項目群A類捐贈人,引領(lǐng)開源生態(tài)新篇章!

    3分鐘快速實現(xiàn)串口PLC遠(yuǎn)程下載程序操作說明

    3分鐘快速實現(xiàn)串口PLC遠(yuǎn)程下載程序操作說明 搜索藍(lán)蜂物聯(lián)網(wǎng)官網(wǎng),即可免費領(lǐng)取樣機使用??!先到先得?。?! 一. 適用產(chǎn)品型號 其余型號網(wǎng)關(guān)此功能正在開發(fā)中,敬請期待。 二. 遠(yuǎn)程下載功能使用流程
    的頭像 發(fā)表于 02-26 15:38 ?988次閱讀
    3<b class='flag-5'>分鐘</b><b class='flag-5'>快速</b>實現(xiàn)串口PLC遠(yuǎn)程下載程序操作說明

    誠邁科技獲評OpenHarmony社區(qū)優(yōu)秀貢獻單位

    1月23日,OpenHarmony社區(qū)年會在京舉行,誠邁科技憑借出色的技術(shù)創(chuàng)新能力以及在生態(tài)建設(shè)方面的突出貢獻,獲評“OpenHarmony社區(qū)
    的頭像 發(fā)表于 01-26 10:04 ?420次閱讀

    OpenHarmony社區(qū)運營報告(2023年12月)

    本月快訊?截至2023年12月22日,OpenAtomOpenHarmony(簡稱“OpenHarmony")社區(qū)累計超過6700名貢獻者,產(chǎn)生26.9萬多個PR,2.4萬多個Star
    的頭像 發(fā)表于 01-20 08:02 ?443次閱讀
    <b class='flag-5'>OpenHarmony</b><b class='flag-5'>社區(qū)</b>運營報告(2023年12月)

    OpenHarmony社區(qū)運營報告(2023年12月)

    ? 截至 2023 年 12 月 22 日,OpenAtom OpenHarmony(簡稱“OpenHarmony\")社區(qū)累計超過 6700 名貢獻者,產(chǎn)生 26.9 萬多個 PR
    發(fā)表于 01-10 15:44

    OpenHarmony社區(qū)運營報告(2023年12月)

    OpenHarmony")社區(qū)累計超過6700名貢獻者,產(chǎn)生26.9萬多個PR,2.4萬多個Star,6.7萬多個Fork,59個SIG。 ? 2023年12月16日,以“技術(shù)創(chuàng)新,照見未來”為主題的首屆開放原子
    的頭像 發(fā)表于 01-08 21:15 ?784次閱讀
    <b class='flag-5'>OpenHarmony</b><b class='flag-5'>社區(qū)</b>運營報告(2023年12月)