如何貢獻代碼到Apollo GitHub

1準備

1.1 註冊/登錄GitHub

登錄https://github.com,若沒有GitHub賬號則先進行註冊。

1.2 fork apollo代碼庫到自己倉庫

訪問apollo代碼庫https://github.com/ApolloAuto/apollo,點擊“Fork”按鈕fork代碼到自己倉庫:

1.3 clone apollo代碼到本地

fork完成之後會跳轉到自己賬號的apollo倉庫,點擊“Clone or download”按鈕,會彈出一個下載鏈接(形如:https://github.com/javeme/apollo.git):

複製該鏈接,在本地通過git clone {GIT REPO}命令進行下載:

1.4 配置本地apollo代碼倉庫用戶信息

配置用戶名和郵箱以備提交代碼使用:

cd apollo
git config user.name "XX"
git config user.email [email protected]

 

2本地修改

2.1 修改代碼

以一個小修改爲例:vim modules/common/kv_db/kv_db.cc,修改內容如下圖:

2.2 驗證代碼

輸入命令bash apollo.sh check進行本地編譯、測試,以驗證修改代碼的正確性。

2.3 編輯commit message

驗證沒問題後,提交修改代碼到本地倉庫:git commit -a,並輸入如下圖格式的commit message,內容由本次修改的代碼而定:

 

注意:commit message的title和body之間需要空一行,title儘量使用簡短的語言概括所修改的內容,可以在body中添加詳細的描述。如果是解決issue的話請關聯上issue號碼,如加上一行:Fixes #1234

 

3提交

3.1 提交到github

將修改提交到自己的github遠程倉庫:git push origin leveldb-get-error-check

成功之後在github自己apollo倉庫首頁會出現提示“Your recently pushed branches”:

3.2 提交pull request

點擊github自己apollo倉庫首頁上的“Compare & pull request”按鈕來創建一個pull request:

跳轉到下一個頁面,如果需要的話可以對pull request消息進行編輯,默認填入的是之前填寫的git commit message。最後點擊“Create pull request”按鈕提交:

提交成功後,如果CLAassistant提示沒有簽署CLA協議則點擊按鈕簽署即可(我這裏由於之前已簽署過所以顯示“signed”,注意必須要簽署CLA纔可合入代碼):

3.3 等待review,被合入

提交成功後等待review即可,如果有人給出了合理意見則繼續修改,本地修改後通過git commit -a --amend命令提交,並按照上述的流程從3.1重新走一遍。

如果運氣好的話可能會直接被合入到apollo代碼庫。

4參考

關於代碼風格等要求見官網文檔:

https://github.com/ApolloAuto/apollo/blob/master/CONTRIBUTING.md

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章