本文將指導使用者如何成為 OceanBase Contributor , 即使是一個小白, 也可以成為 Contributor

步驟

準備工作

1.在   上註冊一個使用者, 如果已經有了一個賬戶, 則跳過此步驟

    因為現在 github 不允許通過使用者名稱和密碼提交程式碼, 需要使用者自己建立 token 來提交程式碼,   https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token , 用新的 token 來代替過去的密碼來提交。

2.fork  oceanbase/oceanbase 到自己 github 賬戶下

  如果已經 fork 了程式碼, 在 github 點選 

3.準備編譯環境, 參考文件   how-to-build

程式碼編寫

1.下載程式碼到本地，

# git clone ${使用者}/oceanbase

備註: ${使用者} 為使用者的名字

2.在  oceanbase/oceanbase/issues 上找一個簡單的issue,

推薦找一個拼寫錯誤的 issue, 修改這些 issue 比較簡單, 容易上手.  oceanbase/oceanbase/issues?q=is%3Aissue+is%3Aopen+label%3Atypos建立對應的分支

# git checkout -b issue${issue_number}

備註: ${issue_number} 為 issue 的編號

3.在 IDE 中修改程式碼，推薦使用 vscode , 並且 vscode 使用遠端連結功能.

4.修改完程式碼後，進行編譯

#bash build.sh debug --init --make

大概等待10分鐘

5.開始單元測試，如果只是修改註釋， 修改文件,，則不需要進行單元測試

# cd build_debug/unittest/
#make -j 4
#./run_tests.sh

整個過程，需要1個小時

程式碼提交

# git status
# 位於分支 master
# 尚未暫存以備提交的變更：
#   （使用 "git add <file>..." 更新要提交的內容）
#   （使用 "git checkout -- <file>..." 丟棄工作區的改動）
#
#	修改：      ../../src/${修改檔案}
#
修改尚未加入提交（使用 "git add" 和/或 "git commit -a"）

備註: ${修改檔案}為修改檔案 然後

git add ${修改檔案}
git commit -m "fixed ${issue_number}, xxxxxxx"
git push origin issue${issue_number}

備註： ${issue_number} 為 issue 的 number commit的 comments 需要帶上"fixed ${issue_number}", 這樣可以將 issue number 和 pull request 關聯起來 然後建立 pull request 即可,建立 pull request 後, 需要簽署 CLA, 如果已經簽署了, 類似這樣 後續等待 OceanBase 的官方進行 approve

大家可瀏覽此網站檢視更多注意事項：

oceanbase/oceanbase/wiki/how_to_contribute