色哟哟视频在线观看-色哟哟视频在线-色哟哟欧美15最新在线-色哟哟免费在线观看-国产l精品国产亚洲区在线观看-国产l精品国产亚洲区久久

0
  • 聊天消息
  • 系統消息
  • 評論與回復
登錄后你可以
  • 下載海量資料
  • 學習在線課程
  • 觀看技術視頻
  • 寫文章/發帖/加入社區
會員中心
創作中心

完善資料讓更多小伙伴認識你,還能領取20積分哦,立即完善>

3天內不再提示

從Docs倉 開啟OpenHarmony社區達人進階之旅

OpenAtom OpenHarmony ? 來源:OpenAtom OpenHarmony ? 作者:OpenAtom OpenHarmony ? 2022-06-30 15:17 ? 次閱讀

戰“碼”先鋒,PR 征集令活動正如火如荼地進行中,截至 6 月 6 日,提交 PR 總數 678個,合入 PR 數 363 個。為了更好地賦能開發者,幫助大家更加便利地參與社區活動,成為社區達人。

我們邀請 OpenAtom OpenHarmony(以下簡稱“OpenHarmony”) SIG Docs 的 Committer – NEEN YANG,為大家分享《參與文檔貢獻,開啟 OpenHarmony 社區貢獻進階之旅》。她從:文檔的作用、好文檔的三個特性、文檔貢獻的形式、文檔 PR 的類別、OpenHarmony社區文檔類型等 6 個方面為大家詳細介紹了如何為 OpenHarmony 社區貢獻文檔 PR。

參與戰“碼”先鋒,PR 征集令!你可以在 Gitee 的 OpenHarmony 代碼倉提交 PR 參與活動,和全球開發者同臺競技,比拼技藝,為 OpenHarmony 貢獻力量。

文檔的重要性

文檔對開源項目有著非常重要的意義,是開發者熟悉項目的第一步,也是開發者考慮是否參與項目的重要因素。在開源中國聯合 Gitee發布的《2021 中國開源開發者報告》中指出:60% 的開發者將相關文檔/資料是否豐富作為使用開源軟件場景的重要條件。除此之外,在 GitHub 于 2021 年發布的報告中也明確提出,開源項目中更新及時、資源豐富的文檔,能夠幫助開發人員平均產出提升 50%。

好文檔的特性

好的文檔是一個好的開始。如何寫出好的文檔,一本面向技術寫作者的參考書籍:Developing Quality Technical Information: A Handbook for Writers and Editors 給出了解釋。它將文檔質量按照用戶視角分為三個方面:易使用、易理解、易查找。 其中易使用指的是文檔符合用戶場景幫助用戶高效完成任務,具體從用戶任務視角、內容正確、內容完整三個維度進行定義。易理解即:內容清晰、描述具體、風格一致,這樣能夠幫助開發者快速理解文檔意義和方便后續對項目的學習。易查找是指內容獲取是否高效便捷,從信息架構、可檢索、視覺效果三個維度進行定義。

0e26bb38-f61b-11ec-ba43-dac502259ad0.png

有了好文檔的定義,要寫出這樣一份具備三易特征的好文檔,技術寫作者需要具備哪些能力?NEEN YANG 在分享中給出的解釋是,首先要具備好的技術理解力,要站在用戶的視角,寫出面向用戶的任務式的文檔。同時要確保內容的結構設計合理、邏輯清晰。還要具備開發者的同理心,例如內容的難易程度,相關知識的顆粒度,需要考慮對不同類型的開發者有不同的寫作風格。最后是語言的表達需要行文流暢,通俗易懂。

文檔貢獻的三種形式

首先大家在使用 OpenHarmony 的代碼時,遇到任何問題,提出問題就是一種貢獻。例如在運行某一段示例代碼,發現示例代碼運行時報錯,或發現文檔中操作步驟有誤,亦或是發現內容不完整等,提出問題就能夠幫助項目改善優化。在其他開發者遇到類似問題時,問題的修復也避免了大家重復試錯。當大家對 OpenHarmony 的產品能力已經有了一定的認知,便可以參與具體的子系統、技術領域學習與貢獻。隨著技能成長,也會涌現出一些專家,這樣就能夠參與文檔的評審。 在參與文檔評審前,建議大家先要了解文檔的貢獻指南,了解如何參與貢獻。接著了解風格指南,該指南針對 OpenHarmony 文檔的語言風格、文檔結構、內容元素等提供規范要求或參考建議,確保 OpenHarmony 文檔具備一致的風格,同時幫助開發者高效參與文檔貢獻。同時需要注意的是寫作模板,了解不同類別文檔內容的模板定義要求,信息要素。最后學習編程規范,了解不同編碼語言規范要求,確保能夠寫出符合規范要求的代碼、示例。

掌握了基礎知識,大家就可以提交 Pull Request 參與內容貢獻。在此之前,也建議大家先熟悉 Markdown 編寫語法技巧、熟悉 Git/Gitee 平臺使用方法。查閱并借鑒其他貢獻者發起的 Issue 或 PR,貢獻此類內容。

0e50c77a-f61b-11ec-ba43-dac502259ad0.png

貢獻文檔PR的類型

對于新手開發者來說,規范性的內容修復是一個好的開始。社區提供了 OpenHarmony 風格指導和模板要求,大家可以根據相關規范要求,在學習和使用文檔過程中,發現文檔中不符合風格要求或模板要求的問題。如缺少信息元素、描述風格問題,資料規范問題、代碼規范問題,Markdown 規范、術語一致性、邏輯表達不清晰、標點符合或鏈接缺失等基礎問題,通過提交 Pull Request 進行修復。 有一定經驗的開發者可能會參與小功能開發、測試、體驗,也可能研究源碼。在這些活動過程中,可能會發現文檔內容的準確性和可用性方面的問題。 隨著參與貢獻,技能得到不斷提升,可能你已經進階為一位資深的開發者。具備獨立貢獻新內容的能力,例如在處理某一個大家經常遇到的問題后,形成了一些經驗,可以貢獻一篇 FAQ,分享問題處理經驗指導。或者在使用社區里其他第三方貢獻的工具、測試能力時,可以為這些工具撰寫使用指導,幫助更多開發者快速上手。社區第三方的芯片廠家、開發板廠商參與芯片移植過程,貢獻了多篇芯片移植案例;技術翻譯專業的同學們,也可以參與本地化翻譯貢獻內容。

貢獻的內容可以多樣,但需要各位開發者謹記尊重原創,一切為了開發者的原則。能夠提升開發者體驗,幫助開發者更加高效地學習、開發、調測、問題處理,這些內容貢獻都是我們倡導的。

0e7eacee-f61b-11ec-ba43-dac502259ad0.png

提交文檔PR示例

方法和經驗都有了,我們來看幾個樣例。瞄準文檔基礎規范類型發現問題并修復,社區小白也能得心應手提 PR。比如以下的幾個 PR,分別從修復拼寫錯誤、優化文檔描述、修復鏈接等幾個方面展示了幾個基礎規范類文檔 PR。

0ea66720-f61b-11ec-ba43-dac502259ad0.png

對于有經驗的開發者,可以發現內容的準確性和可用性的問題,并做相應的修復。此處以社區開發者九弓子的問題反饋舉例,在 RK3568 開發板燒錄時,工具提示了燒錄異常處理指導,文檔中未明確提醒,開發者容易忽略“燒錄異常”的相關提示。通過在文檔中提 PR,增加相關提示,提醒其他開發者規避此類問題,幫助他們更高效地完成開發板燒錄。

0ed30316-f61b-11ec-ba43-dac502259ad0.png

還有一個非常重要的貢獻方式:貢獻新內容。示例是 OpenHarmony 社區共建伙伴拓維信息貢獻的芯片移植案例,將芯片移植的過程、經驗、問題處理等總結成為移植案例,幫助社區更多芯片廠商等參考借鑒,為社區生態繁榮做出了貢獻。

0f0669ea-f61b-11ec-ba43-dac502259ad0.png

OpenHarmony社區文檔展示

從開發者官網進入后,選擇支持-文檔頁,即可一站式便捷獲取所有 OpenHarmony 核心功能配套的入門基礎知識、應用開發、開發板開發快速上手;便于學習上手的代碼示例、Codelabs 教程;各子系統/特性開發指南、工具使用指南、API 參考等。同時,可以獲取開發者關注的版本更新說明、API接口變更、常見問題、貢獻指導等專題

0f45acfe-f61b-11ec-ba43-dac502259ad0.png

我們欣喜地發現,有 400+ 位社區開發者參與了 OpenHarmony Docs 倉貢獻,感謝大家的持續關注和反饋。歡迎更多的開發者在參與 OpenHarmony 開源項目中,持續關注 SIG Docs,反饋文檔建議和需求,與我們一同持續提升文檔體驗。

我們堅信社區開發者的共建力量,攜手同行、并肩協作,打造健康、蓬勃發展的 OpenHarmony 社區。也期待更多的文檔貢獻者、最佳貢獻者產生。

相關資源匯總

OpenHarmony Docs倉

https://gitee.com/openharmony/docs

OpenHarmony官網

https://docs.openharmony.cn/

OpenHarmony貢獻指南

https://gitee.com/openharmony/docs/tree/master/zh-cn/contribute

OpenHarmony風格指導

https://gitee.com/openharmony/docs/tree/master/zh-cn/contribute/style-guide

OpenHarmony文檔模板

https://gitee.com/openharmony/docs/tree/master/zh-cn/contribute/template

OpenHarmony編程規范

https://gitee.com/openharmony/community/blob/master/sig/sig-QA/%E7%BC%96%E8%AF%91%E8%A7%84%E8%8C%83.md

OpenHarmony社區文檔生產流程

https://gitee.com/openharmony/docs/blob/master/zh-cn/contribute/docs-release-process.md

聲明:本文內容及配圖由入駐作者撰寫或者入駐合作網站授權轉載。文章觀點僅代表作者本人,不代表電子發燒友網立場。文章及其配圖僅供工程師學習之用,如有內容侵權或者其他違規問題,請聯系本站處理。 舉報投訴
  • OpenHarmony
    +關注

    關注

    25

    文章

    3716

    瀏覽量

    16273

原文標題:30分鐘成為Contributor|很多人都是從Docs倉 開啟OpenHarmony社區達人進階之旅

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

收藏 人收藏

    評論

    相關推薦

    鴻蒙原生開源庫ViewPool在OpenHarmony社區正式上線

    近日,由伙伴參與共建的鴻蒙原生開源庫“ViewPool”在OpenHarmony社區正式上線。這個開發庫是基于OpenHarmony技術孵化的成果,充分發揮了平臺的技術特性,同時融入了伙伴在應用開發
    的頭像 發表于 12-20 14:44 ?164次閱讀

    OpenHarmony人才生態大會南向生態社區發展論壇在武漢圓滿舉辦

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

    OpenHarmony人才生態大會南向生態社區發展論壇在武漢圓滿舉辦

    11月27日,OpenHarmony人才生態大會2024在武漢隆重舉行。當日下午的 OpenHarmony南向生態社區發展論壇(以下簡稱“論壇”)上,眾多社區伙伴、企業代表、技術專家與
    發表于 11-29 09:54

    如何在開源鴻蒙OpenHarmony開啟SELinux模式?RK3566鴻蒙開發板演示

    本文介紹開源鴻蒙OpenHarmony系統下,開啟/關閉SELinux權限的方法,觸覺智能Purple Pi OH鴻蒙開發板演示,已適配全新OpenHarmony5.0 Release系統!
    的頭像 發表于 11-18 19:03 ?312次閱讀
    如何在開源鴻蒙<b class='flag-5'>OpenHarmony</b><b class='flag-5'>開啟</b>SELinux模式?RK3566鴻蒙開發板演示

    第三屆OpenHarmony技術大會星光璀璨、致謝OpenHarmony社區貢獻者

    (技術專家組)、TSG星光貢獻者和星光OpenHarmony技術俱樂部、星光導師、星光貢獻者、星光活動等OpenHarmony社區貢獻者,大會同步舉行了授牌儀式。作為智能終端領域發展速度最快的開源
    的頭像 發表于 10-21 14:10 ?212次閱讀

    開放原子開源生態大會OpenHarmony生態主題演講報名開啟

    展示OpenHarmony的技術創新和產業落地成果,分享開源社區生態進展。 誠邀全球開源操作系統產業伙伴、技術大咖和學術專家,共同見證開源賦能產業的國際盛會! 掃描下方二維碼報名
    發表于 09-19 22:02

    400萬!深開鴻OpenHarmony代碼貢獻量再創里程碑!

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

    OpenHarmony之開機優化

    投票機制,此機制是針對開機動畫而設計的,參考文檔:OpenHarmony開機動畫流程_小~Q-Laval社區 可以使用Bootchart工具抓一份火焰圖如下所示: 所以這個時候我們可以啟動順序來
    發表于 07-01 16:39

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

    分論壇”為承載,聚焦OpenHarmony 技術革新,攜手百位技術專家共同交流開發者關心的技術內容,全方位了解最新技術進展。 OpenHarmony開源三年多以來,社區快速成長,已成為“下一代智能終端
    發表于 05-14 15:23

    【鴻蒙】OpenHarmony 4.0藍牙代碼結構簡析

    OpenHarmony 4.0藍牙代碼結構簡析前言 OpenHarmony 4.0上藍牙和目錄結構進行一次較大整改,本文基于4.0以上版本對藍牙代碼進行分析,便于讀者快速了解和學習
    的頭像 發表于 02-26 16:08 ?1539次閱讀
    【鴻蒙】<b class='flag-5'>OpenHarmony</b> 4.0藍牙代碼結構簡析

    誠邁科技獲評OpenHarmony社區優秀貢獻單位

    1月23日,OpenHarmony社區年會在京舉行,誠邁科技憑借出色的技術創新能力以及在生態建設方面的突出貢獻,獲評“OpenHarmony社區優秀貢獻單位”。誠邁科技高級副總裁陳璟出
    的頭像 發表于 01-26 10:04 ?412次閱讀

    開鴻智谷受邀參加OpenHarmony社區年會

    1月23日,開放原子開源基金會OpenHarmony社區年會在北京隆重召開。作為開放原子開源基金會黃金捐贈人、OpenHarmony項目群A類捐贈人,開鴻智谷重磅參加本次活動,董事長李新宇,總裁廖
    的頭像 發表于 01-26 08:30 ?533次閱讀
    開鴻智谷受邀參加<b class='flag-5'>OpenHarmony</b><b class='flag-5'>社區</b>年會

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

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

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

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

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

    OpenHarmony")社區累計超過6700名貢獻者,產生26.9萬多個PR,2.4萬多個Star,6.7萬多個Fork,59個SIG。 ? 2023年12月16日,以“技術創新,照見未來”為主題的首屆開放原子
    的頭像 發表于 01-08 21:15 ?774次閱讀
    <b class='flag-5'>OpenHarmony</b><b class='flag-5'>社區</b>運營報告(2023年12月)
    主站蜘蛛池模板: 99精品久久久久久久| 亚洲日韩精品AV中文字幕| 肉多荤文高h羞耻校园| 兽交白浆喷水高潮| 亚洲AV中文字幕无码久久| 亚洲精品久久久午夜福利电影网| 野花香HD免费高清版6高清版| 在线播放av欧美无码碰| 99精品国产自在自线| 公交车轮C关老师| 国产亚洲精品99一区二区| 久99久热只有精品国产99| 米奇影视999| 欧美一道本一区二区三区| 沈芯语麻豆0076 视频| 亚洲欧美一区二区三区导航| 在线精品一卡乱码免费| 扒开她的黑森林让我添动态图| 国产白丝JK被疯狂输出视频| 寂寞夜晚视频在线观看| 美女拔萝卜| 天天久久影视色香综合网| 妖精视频一区二区免费| a免费在线观看视频| 国产精品日本不卡一区二区| 久久精品在现线观看免费15| 欧美另类老少配hd| 亚州免费一级毛片| 8x华人免费视频| 国产精品人成在线播放新网站| 精品久久电影网| 日本强好片久久久久久AAA| 成年人深夜福利| 国产毛片A级久久久不卡精品| 久久久国产精品免费A片蜜臀| 欧美乱码伦视频免费66网| 性做久久久久免费观看| 67194成网页发布在线观看| 国产精品久久久久久人妻精品流| 久久视频这里只精品99热在线观看 | 亚洲精品永久免费|