怎么用apache flink開發(fā)一個issue

fork代碼

首先我們要有一個自己的github賬號，我們需要把flink的代碼fork到自己的賬號下，打開https://github.com/apache/flink，點擊這個fork按鈕，之后我們就會在我們自己的賬號下看到相應的工程了。

下載到本地

之后我們就可以把剛才fork的flink的代碼下載到我們的本地，可以用下面的命令:

cd my_workspace  
git clone  https://github.com/zhangjun0x01/flink.git

添加遠程倉庫

接下來我們添加一個apache的遠程倉庫，主要是為了后期更新代碼。

git remote add apache https://github.com/apache/flink.git

之后執(zhí)行查詢遠程倉庫命令git remote -v，可以看到有兩個遠程倉庫。

origin https://github.com/zhangjun0x01/flink.git (fetch)
origin https://github.com/zhangjun0x01/flink.git (push)
apache https://github.com/apache/flink.git (fetch)
apache https://github.com/apache/flink.git (push)

添加新分支

接下來，添加一個新分支，用于開發(fā)我們的代碼。分支的名字可以自己隨便起，比如為了方便區(qū)分和查詢，我們可以起一個和這issue同名的分支名，或者根據(jù)功能起一個自己好識別的分支名.

我這個是我起了一個和這個功能相關的分支名.

https://github.com/zhangjun0x01/flink/tree/flink-orc-input

然后我們現(xiàn)在就可以在這個分支上開發(fā)自己的代碼了，開發(fā)完代碼之后，我們需要檢查一下代碼的規(guī)范，這個也就是checkstyle

寫測試代碼

最后開發(fā)完了相關的代碼之后，需要在相關的測試類里面添加相應的測試代碼，如果添加一個新功能，還需要添加相應的文檔。

提交代碼

我們開發(fā)完了代碼之后，這段時間可能flink的主分支已經(jīng)有了代碼的更新，所以我們?yōu)榱吮苊鉀_突，還需要把最新的代碼更新下來。首先切換到主分支

git checkout master 
git pull apache master

之后，我們切換到我們的分支：

# 切換到自己的分支
git checkout flink-orc-input
# 添加剛才改動的代碼，如果不確定改了哪些，可以git status看一下
git add your_code 
git commit -m '注釋'
# 把變化的代碼添加到我們的分支
git rebase
# 提交分支到自己的倉庫
git push origin flink-orc-input  
  

提交到社區(qū)

我們提交分支之后，就可以提交相應的PR（Pull Request）了，比如我的這個PR：https://github.com/apache/flink/pull/11434 。提交的時候注意標題要寫成 [ISSUE] + title的形式，比如 [FLINK-16646] [orc] Flink read orc file ......    這樣的話就能把你這個pr和issue自動關聯(lián)上。

之后我們就能在相應的issue頁面看到關聯(lián)的PR

合并PR

你的代碼提交完之后，之后會有相關的committer或者其他人幫你review代碼，當然你也能幫別人review代碼，這個也是你貢獻社區(qū)的一種方式。

如果committer認同了你的改動，然后他就會把你的改動合并到master分支，或者是其他相應的分支。

比如我這個，不僅僅是改了master，還改了1.10分支，所以這里有兩個關聯(lián)的PR。