GitHub 上有許多開源專案,而每個開源專案通常也都有開放給開發者社群做共同開發或維護,通常只需要遵守該專案的開發規則,每個人都可以進行提交。本篇就使用非常簡單的步驟,來介紹如何參與 GitHub 上面的開源專案協作之相關流程。

開始參與開源專案的開發

  1. 從你想參與開發的專案 fork 程式碼庫到自己的 GitHub:
    (這裡以 Frontend 為範例專案)
    點擊專案右上角的 Fork 按鈕:
    fork

  2. 從自己的 GitHub 將專案 Clone 下來:

    git clone https://github.com/<你的GitHub帳號>/example-repo.git
    cd example-repo
    
  3. 切換到專案開發的主分支:
    注意到你所參與開發的專案是使用什麼開發流程。
    ex. GitHub Flow
    假設專案開發的主分支在 develop:

    git checkout develop
    
  4. 依照功能或開發項目從主分支建立一個新分支:

    git checkout -b feature/homepage
    
  5. 接者便可以開始進行開發,待開發完成之後,將程式碼 commit 並 push 到你自己的 Repository:

    git add .
    git commit -m "feat: add homepage and the reative pages"
    
    # 如果尚未在 remote 建立分支
    git push -u origin feature/homepage
    
    # or
    # 如果已經在 remote 建立分支並 push 過了
    git push
    
  6. 回到你所參與的開源專案 GitHub 頁面

  7. 點擊 Compare & pull request

    Compare & pull request

  8. 確認資訊並填寫 PR 的訊息,接著送出:

    Create pull request

  9. 看到下列頁面就完成了:

    PR Created

將所參與的專案的更動同步更新到自己的 Repository

這邊以 upstream 代表你所參與開發的專案

  • 還沒設定共同專案的 Repo 到自己的本地專案以前,請先設定:

    git remote add upstream https://github.com/example-org/example-repo.git
    
  • 已經設定好 upstream 了,之後每次只要執行下面的指令就可以更新 develop 分支囉:

    git checkout develop
    git pull upstream develop
    git push origin develop
    
    # 如過 push 到 develop 時出現相關錯誤訊息,請執行:
    git push -f origin develop