主要步驟
以下步驟整理自參考資料的第一個連結:
- Step 1: 到你想修改的專案的GitHub頁面,按下 Fork,這時會把這個專案複製一份到你自己的倉庫裡
- Step 2: 將這個自己倉庫裡的專案
git clone
到自己的電腦裡 - Step 3: 開一個新的分支
git checkout -b <新分支名>
- Step 4: 開始修改原始碼
- Step 5:
commit
修改後的原始碼- 先
git add
- 再
git commit -m <commit的訊息>
- 先
- Step 6: 將這一份專案重新
push
回到 GitHubgit push origin <新分支名>
- Step 7: 接下來到你自己GitHub倉庫,找到你剛剛
push
上去的專案,應該會在專案頁面看到一個Compare & pull request
的綠色按鈕,按下去,這一步會開始比對程式碼是否可以跟原作者的程式碼合併在一起。一個理解Pull request
的方式就是想像那個原作者站在他的專案裡面,現在你想要「要求」他將你所更新的程式碼給「拉」進來他的專案中。 - Step 8: 填寫
Pull request
的標題和內文,稍微敘述一下你做了什麼,然後按Create pull request
後送出。 - Step 9: 接下來就等email通知,原作者是否接受你所做的
Pull request
。
在參考資料的第二個連結中,還多了三個步驟要插在上述的 Step 2 後面,主要是做更多的檢查工作,已確保你clone下來的程式碼與原專案的程式碼是同步的(想像一個情況,就在你clone下來以後,原作者剛好更新了他的程式碼,那麼這時你手上有的就不是最新的了),在這裡先一併補上:
- 檢查你clone下來的專案的
"origin" remote
是不是就是剛剛 fork 進你 GitHub 倉庫裡的那個(如果Step 1, 2有做對的話,通常這一步就是正確的)- 以
git remote -v
做檢查
- 以
- 將原作者的專案設為
"upstream" remote
git remote add upstream <原作者的專案的Git網址>
- 從上一部所設定的
"upstream" remote
下載原作者最新的程式碼git pull upstream master
參考資料
- GitHub專案: firstcontributions /
first-contributions https://github.com/firstcontributions/first-contributions - Step-by-step guide to contributing on GitHub (Data School) https://www.dataschool.io/how-to-contribute-on-github/