一起為開源貢獻! 提交第一個PR | 新手向
Pull Request (PR) | fork 一個專案到最後的提交 | 同步原始專案
一起為開源貢獻! 提交第一個PR | 新手向
前幾個月我對於如何開始貢獻開源專案感到困惑,從中做了許多研究。我將從 fork 一個專案到最後的提交 Pull Request (PR) 的過程都整理起來,希望能幫助你順利提交你的第一個 PR。
步驟1: 選擇一個專案
首先,選擇一個你感興趣的開源專案。GitHub 是一個尋找開源專案的好地方。選擇一個適合新手的專案是非常重要的,很多專案會在其 README
文件中標記 good first issue
。
步驟2: Fork 專案
Fork 是指將別人的專案複製一份到你的 GitHub 賬號下。這樣你就可以在自己的版本上自由地進行更改。在專案的 GitHub 頁面上找到 “Fork” 按鈕並點擊它。
步驟3: clone專案到本地
在你的電腦上選擇一個工作目錄,使用以下命令克隆剛才 fork 的專案:
1
2
git clone https://github.com/[你的用戶名]/[專案名].git
cd [專案名]
步驟4: 創建一個新的分支
在你開始作出更改之前,最好在一個新的分支上工作,這樣可以保持專案的整潔。使用以下命令創建並切換到新分支:
1
git checkout -b [新分支名]
步驟5: 進行更改
這是最重要的一步。在這個階段,你可以開始實際對專案做出貢獻。這可以是修復一個 bug、添加一個新功能,或者改進文檔。記得在開始工作之前,確保你的 fork 與原始專案同步,最下面有教大家如何同步。
步驟6: 提交更改
完成更改後,使用以下命令將它們添加到你的分支,你可以先使用
git status
查看你改動的文件:
1
2
git add .
git commit -m "描述你的更改"
步驟7: 推送到你的 GitHub
使用以下命令將你的分支推送到 GitHub:
1
git push origin [新分支名]
步驟8: 提交 Pull Request
大部分的專案會要求你再提交 PR 前跑過相關的測試,你可以在專案的 contributing guidelines 找到相關規定,建議可以在提交 PR 前先看看。回到原始專案的 GitHub 頁面,你會看到一個提示你提交 Pull Request 的按鈕,可以跟著以下步驟操作:
a) 點擊 New Pull Request
b) 選擇 compare across forks
c) 選擇你的 repo
d) 確認你的 commit 並點選 Create pull request
e) 填上你想解決的 issue 內容,並按下 Create pull request
當你按下 Create pull request 後,就會向該專案提交你的 PR,接著就是等管理員審核,來回可能會需要一些修改。
其他:同步原始專案最新的 code
在開始貢獻之前,確保你的 fork 與原始專案保持同步是很重要的。這樣可以避免在合併 PR 時出現衝突。以下是同步的步驟:
a) 配置一個遠程 upstream
首先,你需要將原始專案設置為一個新的遠程倉庫(upstream)在你 fork 的專案目錄中,執行以下命令來添加 upstream:,你可以使用 git remote -v
來查看遠程狀況,一般來說新 fork 下來的專案只會看到你自己的 origin。
1
git remote add upstream https://github.com/[原始專案擁有者]/[原始專案名].git
b) 拉取 upstream 的更改
使用以下命令從 upstream 拉取最新的更改:
1
git fetch upstream
c) 合併到你的本地 master 分支
確保你在本地 master 分支上,然後將 upstream 的更改合併到你的 master 分支:
1
2
git checkout master
git merge upstream/master
d) 推送更改到你的 GitHub fork
最後,將這些更改推送到你的 GitHub fork:
1
git push origin master
這樣,你的 fork 就與原始專案同步了。
結語
恭喜你!你剛剛完成了提交你的第一個 PR 的過程。開源社群是基於互助和分享的,每一次貢獻都是對社群的一大貢獻。不要害怕犯錯,學習和成長是每個開源旅程的一部分