天天看點

如何給openharmony正确提Pr

本篇教程旨在幫助萌新們一起參與到OpenHarmony的開源事業中,讓每個人成為開源人,星星之火,可以燎原!最下面有我的入群方式。

在這之前先說一下,從我這兒報名,送出Pr

有哪些福利

  • 官方的T恤
  • 我的鴻蒙書籍
  • 我的小鳥擺件

​​如何參與​​

活動範圍涵蓋OpenHarmony主幹倉、SIG倉、三方庫,共計1000+個代碼倉:

  • OpenHarmony主庫組織位址:

​​gitee.com/openharmony​​

  • OpenHarmony SIG組織位址:

​​gitee.com/openharmony…​​

  • OpenHarmony三方庫組織位址:

​​gitee.com/openharmony…​​

前提條件

  1. 有一個​​Gitee賬号​​,沒有的話,記得​​用郵箱注冊一個​​
  2. ​​簽署開發者原創聲明​​
  3. ​​本地安裝Git​​

如果Git基礎薄弱,也是可以用圖形化界面

windows推薦

  • ​​tortoisegit​​
  • ​​sourcetree​​

mac推薦

  • ​​sourcetree​​

接下來就是手把手的環節了

這兒也有兩個圖檔可以看一下

  • ​​FAQ​​
  • ​​十分鐘極速提Pr​​

一、配置Git

​​注冊碼雲賬号​​

​​本地安裝Git​​

1.注冊

位址: ​​gitee.com/​​ 注冊碼雲賬号,隻要點選導覽列中的“注冊”,或者點選首頁中那個大大的“加入碼雲”按鈕,即可進入注冊頁面。

如何給openharmony正确提Pr

輸入賬号、郵箱、密碼,然後點選注冊按鈕.

注冊的時候最好取一個有意義的名字,比如姓名全拼,昵稱全拼,如果被占用,可以加上有意義的數字.​​比如我的​​

注冊完官方會向大家的郵箱發送一份激活郵件,請點選其中的連結激活賬号,賬号激活後,注冊流程就算完成了。注冊完畢即以新注冊的賬号登入,登入後即進入使用者的控制台頁面。

找不到ssh-keygen指令是因為你的工作目錄不在ssh-keygen.exe所在目錄下,導緻找不到指令,是以切換工作目錄到ssh-kengen所在目錄(Git/usr/bin/)即可。以我為例,我的Git安裝在D盤Git下,是以進行操作 cd D:/Git/usr/bin/ ,然後執行 ssh-keygen -t rsa -C “您的郵箱位址” 即可

2.公鑰認證管理

開發者向碼雲版本庫寫入最常用到的協定是 SSH 協定,因為 SSH 協定使用公鑰認證,可以實作無密碼通路,而若使用 HTTPS 協定每次身份認證時都需要提供密碼。使用 SSH 公鑰認證,就涉及到公鑰的管理。

3.如何生成ssh公鑰

你可以按如下指令來生成sshkey:

這個郵箱就是你的上面的郵箱

ssh-keygen -t rsa -C "[email protected]"  

# Generating public/private rsa key pair...
# 三次回車即可生成 ssh key      

比如我的

ssh-keygen -t rsa -C "[email protected]"      

然後三次回車即可生成 ssh key,

檢視你的 public key,

mac

cat ~/.ssh/id_rsa.pub
# ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6eNtGpNGwstc....      

windows

在C:\Users\使用者.ssh目錄下找到id_rsa.pub複制裡面所有内容

如何給openharmony正确提Pr

4.添加public key到碼雲

并把他添加到碼雲(Gitee.com) ​​SSH key添加位址​​

如何給openharmony正确提Pr

添加後,在終端(Terminal)中輸入

ssh -T [email protected]      

若傳回

Welcome to Gitee.com, yourname!      

則證明添加成功。

二、DCO簽署

1.DCO簽署網址

​​開發者原創聲明Developer Certificate of Origin​​

​​開發者原創聲明​​

2.簽署DCO

注意:

DCO簽署Name 必須要和git config --global user.name 設定保持一緻(其實不一緻也可以,但一緻之後少麻煩)

DCO簽署E-mail必須要和git config --global user.email設定保持一緻

如何給openharmony正确提Pr

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

git config --global user.name "你的名字" 
git config --global user.email "你的gitee綁定郵箱"
git config --global  --list      

比如我的:

git config --global user.name "徐建國" 
git config --global user.email "[email protected]"
git config --global  --list      

三、送出代碼

1.下載下傳代碼

1.1找到要送出代碼的社群代碼倉,fork一個到自己的私有倉中;

比如我fork的是docs倉

原位址:​​gitee.com/openharmony…​​

fork後:​​gitee.com/jianguo888/…​​

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

如何給openharmony正确提Pr

1.2複制自己私有倉的“克隆/下載下傳”中的HTTPS/SSH連結下載下傳代碼

本地建立工作區,然後

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

比如我的

git clone https://gitee.com/jianguo888/docs.git      
如何給openharmony正确提Pr

2.送出代碼

2.1将修改的代碼合入到送出代碼倉中;

必須添加郵箱,否則後面的doc校驗不過

切記:送出的時候必須是-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?

執行​

​git commit --amend --signoff​

​指令 。

2.3如果是對同一個問題修改

git commit --amend      

通常推薦一個一個commit解決一個問題

四、送出ISSUE

1.​​進入社群主代碼建Issue​​(不是fork的代碼倉),同時注意建Issue有很多選項類型可選擇,根據實際情況選擇

名稱

【OpenHarmony開源貢獻者計劃2022】+Issue内容描述

如何給openharmony正确提Pr
如何給openharmony正确提Pr

2.建立成功會生成一個#XXXXX(I5E2H2)的IssueID,後續送出PR可以關聯,關聯PR合入,Issue就會自動關閉。

如何給openharmony正确提Pr

五、送出PR

1.代碼送出到自己的私有倉,重新整理,點選“+ Pull Request”建PR合入代碼到社群主代碼倉;

如何給openharmony正确提Pr

2.進入PR送出界面,可選擇代碼倉庫分支,和關聯ISSUE ID,簡單描述合入的PR修改等資訊;

如何給openharmony正确提Pr

标題都是【OpenHarmony開源貢獻者計劃2022】+你修改的任務摘要

比如我的:

【OpenHarmony開源貢獻者計劃2022】+智能家居中控

如何給openharmony正确提Pr

關聯ISSUE ID

第一步檢視自己的issues ID

如何給openharmony正确提Pr

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

如何給openharmony正确提Pr

3.PR建立成功,首先預設進行DCO檢查,檢查成功,需要手動在評論區輸入回複”start build”方可進入代碼的CI靜态檢查和編譯等操作。

如何給openharmony正确提Pr

六、聯系committer

committer:​​gitee.com/openharmony…​​

1. committer文檔中找到對應的committer負責人首頁,想辦法聯系

這一步,可以找我溝通就好,我幫大家聯系。

我是在committer發現負責人,然後微信搜尋,群裡撈到的。

如何給openharmony正确提Pr
如何給openharmony正确提Pr

​​倉颉語言内測申請​​

參考資料

​​貢獻代碼的流程​​

​​貢獻流程​​

堅果的小夥伴們提的Pr

悠悠森:​​gitee.com/openharmony…​​

​​gitee.com/openharmony…​​