openharmony萌新貢獻(xiàn)指南

本篇教程旨在幫助萌新們一起參與到OpenHarmony的開(kāi)源事業(yè)中，讓每個(gè)人成為開(kāi)源人，星星之火，可以燎原！最下面有我的入群方式。

在這之前先說(shuō)一下，從我這兒報(bào)名，提交Pr，

5分鐘快速為OpenHarmony提交PR（Web）視頻教程

有哪些福利

官方的T恤

官方的貢獻(xiàn)證書

馬克杯

開(kāi)發(fā)板

我的鴻蒙書籍

我的小鳥擺件

如何參與

活動(dòng)范圍涵蓋OpenHarmony主干倉(cāng)、SIG倉(cāng)、三方庫(kù)，共計(jì)1000+個(gè)代碼倉(cāng)：

OpenHarmony主庫(kù)組織地址：

https://gitee.com/openharmony

OpenHarmony SIG組織地址：

https://gitee.com/openharmony-sig

OpenHarmony三方庫(kù)組織地址：

https://gitee.com/openharmony-tpc

前提條件

有一個(gè)Gitee賬號(hào)，沒(méi)有的話，記得用郵箱注冊(cè)一個(gè)

簽署開(kāi)發(fā)者原創(chuàng)聲明

本地安裝Git

如果Git基礎(chǔ)薄弱，也是可以用圖形化界面

windows推薦

tortoisegit

sourcetree

mac推薦

sourcetree

接下來(lái)就是手把手的環(huán)節(jié)了

這兒也有兩個(gè)圖片可以看一下

FAQ

十分鐘極速提Pr

一、配置Git

注冊(cè)碼云賬號(hào)

本地安裝Git

1.注冊(cè)

地址: https://gitee.com/ 注冊(cè)碼云賬號(hào)，只要點(diǎn)擊導(dǎo)航條中的“注冊(cè)”，或者點(diǎn)擊首頁(yè)中那個(gè)大大的“加入碼云”按鈕，即可進(jìn)入注冊(cè)頁(yè)面。

輸入賬號(hào)、郵箱、密碼,然后點(diǎn)擊注冊(cè)按鈕.

注冊(cè)的時(shí)候最好取一個(gè)有意義的名字，比如姓名全拼，昵稱全拼，如果被占用，可以加上有意義的數(shù)字.比如我的

注冊(cè)完官方會(huì)向大家的郵箱發(fā)送一份激活郵件，請(qǐng)點(diǎn)擊其中的鏈接激活賬號(hào)，賬號(hào)激活后，注冊(cè)流程就算完成了。注冊(cè)完畢即以新注冊(cè)的賬號(hào)登錄，登錄后即進(jìn)入用戶的控制面板頁(yè)面。

找不到ssh-keygen命令是因?yàn)槟愕墓ぷ髂夸洸辉趕sh-keygen.exe所在目錄下，導(dǎo)致找不到命令，所以切換工作目錄到ssh-kengen所在目錄(Git/usr/bin/)即可。以我為例，我的Git安裝在D盤Git下，所以進(jìn)行操作 cd D:/Git/usr/bin/ ，然后執(zhí)行 ssh-keygen -t rsa -C “您的郵箱地址” 即可

2.公鑰認(rèn)證管理

開(kāi)發(fā)者向碼云版本庫(kù)寫入最常用到的協(xié)議是 SSH 協(xié)議，因?yàn)?SSH 協(xié)議使用公鑰認(rèn)證，可以實(shí)現(xiàn)無(wú)口令訪問(wèn)，而若使用 HTTPS 協(xié)議每次身份認(rèn)證時(shí)都需要提供口令。使用 SSH 公鑰認(rèn)證，就涉及到公鑰的管理。

3.如何生成ssh公鑰

你可以按如下命令來(lái)生成sshkey:

這個(gè)郵箱就是你的上面的郵箱

ssh-keygen -t rsa -C "xxxxx@xxxxx.com"

# Generating public/private rsa key pair...

# 三次回車即可生成 ssh key

比如我的

ssh-keygen -t rsa -C "852851198@qq.com"

然后三次回車即可生成 ssh key，

查看你的 public key，

mac

cat ~/.ssh/id_rsa.pub

# ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6eNtGpNGwstc....

windows

在C:\Users\用戶.ssh目錄下找到id_rsa.pub復(fù)制里面所有內(nèi)容

4.添加public key到碼云

并把他添加到碼云（Gitee.com） SSH key添加地址

添加后，在終端（Terminal）中輸入

ssh -T git@gitee.com

若返回

Welcome to Gitee.com, yourname!

則證明添加成功。

二、DCO簽署

1.DCO簽署網(wǎng)址

開(kāi)發(fā)者原創(chuàng)聲明Developer Certificate of Origin

開(kāi)發(fā)者原創(chuàng)聲明

2.簽署DCO

注意：

DCO簽署Name 必須要和git config --global user.name 設(shè)置保持一致（其實(shí)不一致也可以，但一致之后少麻煩）

DCO簽署E-mail必須要和git config --global user.email設(shè)置保持一致

3.修改本地的郵箱和簽署郵箱一致

git config --global user.name "你的名字"

git config --global user.email "你的gitee綁定郵箱"

git config --global --list

比如我的：

git config --global user.name "徐建國(guó)"

git config --global user.email "852851198@qq.com"

git config --global --list

三、提交代碼

1.下載代碼

1.1找到要提交代碼的社區(qū)代碼倉(cāng)，fork一個(gè)到自己的私有倉(cāng)中；

比如我fork的是docs倉(cāng)

原地址：https://gitee.com/openharmony/docs

fork后：https://gitee.com/jianguo888/docs

而你后面要git clone的就是后者。

1.2復(fù)制自己私有倉(cāng)的“克隆/下載”中的HTTPS/SSH鏈接下載代碼

優(yōu)先ssh

本地創(chuàng)建工作區(qū)，然后

git clone git@gitee.com:你的giteeID/docs.git

比如我的

git clone git@gitee.com:jianguo888/docs.git

2.提交代碼

2.1將修改的代碼合入到提交代碼倉(cāng)中；

必須添加郵箱，否則后面的doc校驗(yàn)不過(guò)

切記：提交的時(shí)候必須是-s -m

-s的意思就是帶了你的signoff

git add .

git commit -s -m '修改信息' // 提交信息包括你的概要信息

git push -f origin master

比如我的：

git add .

git commit -s -m '修改redeme提高可讀性 ' // 提交信息包含signoff郵箱

git push -f origin master

2.2如何追加signoff到上一次commit?

執(zhí)行git commit --amend --signoff命令 。

2.3如果是對(duì)同一個(gè)問(wèn)題修改

git commit --amend

通常推薦一個(gè)一個(gè)commit解決一個(gè)問(wèn)題

四、提交ISSUE

1.進(jìn)入社區(qū)主代碼建Issue（不是fork的代碼倉(cāng)），同時(shí)注意建Issue有很多選項(xiàng)類型可選擇，根據(jù)實(shí)際情況選擇

名稱

【OpenHarmony開(kāi)源貢獻(xiàn)者計(jì)劃2022】+Issue內(nèi)容描述

2.創(chuàng)建成功會(huì)生成一個(gè)#XXXXX(I5E2H2)的IssueID，后續(xù)提交PR可以關(guān)聯(lián)，關(guān)聯(lián)PR合入，Issue就會(huì)自動(dòng)關(guān)閉。

五、提交PR

1.代碼提交到自己的私有倉(cāng)，刷新，點(diǎn)擊“+ Pull Request”建PR合入代碼到社區(qū)主代碼倉(cāng)；

2.進(jìn)入PR提交界面，可選擇代碼倉(cāng)庫(kù)分支，和關(guān)聯(lián)ISSUE ID，簡(jiǎn)單描述合入的PR修改等信息；

標(biāo)題都是【OpenHarmony開(kāi)源貢獻(xiàn)者計(jì)劃2022】+你修改的任務(wù)摘要

比如我的：

【OpenHarmony開(kāi)源貢獻(xiàn)者計(jì)劃2022】+智能家居中控

關(guān)聯(lián)ISSUE ID

第一步查看自己的issues ID

第二步添加到自己的Pull request的描述里

3.PR建立成功，首先默認(rèn)進(jìn)行DCO檢查，檢查成功，需要手動(dòng)在評(píng)論區(qū)輸入回復(fù)”start build”方可進(jìn)入代碼的CI靜態(tài)檢查和編譯等操作。

六、聯(lián)系committer

committer：https://gitee.com/openharmony/community/blob/master/zh/committer.md

1. committer文檔中找到對(duì)應(yīng)的committer負(fù)責(zé)人主頁(yè)，想辦法聯(lián)系

這一步，可以找我溝通就好，我?guī)痛蠹衣?lián)系。

我是在committer發(fā)現(xiàn)負(fù)責(zé)人，然后微信搜索，群里撈到的。

倉(cāng)頡語(yǔ)言內(nèi)測(cè)申請(qǐng)

參考資料

貢獻(xiàn)代碼的流程

貢獻(xiàn)流程

堅(jiān)果的小伙伴們提的Pr

悠悠森:https://gitee.com/openharmony/docs/pulls/6910

https://gitee.com/openharmony/docs/pulls/6921

https://gitee.com/openharmony/docs/pulls/6937

https://gitee.com/openharmony-sig/knowledge_demo_entainment/pulls/35

https://gitee.com/openharmony-sig/knowledge_demo_travel/issues/I5IKVK