iT邦幫忙

2025 iThome 鐵人賽

DAY 19
0
自我挑戰組

Git 與 GitHub 入門日誌系列 第 19

Day 19:Code Review 實戰 — 如何給出與接受意見

  • 分享至 

  • xImage
  •  

在前幾天,我們已經學會:

  1. 如何 Fork 專案並建立 Pull Request
  2. 如何保持 Fork 與原始專案同步

今天我們要進一步學習 Code Review。
在真實的開源專案或團隊協作裡,
Pull Request 往往不會直接被合併,
而是需要經過審查 (Review),確認程式碼是否符合專案需求與規範。


Code Review 的作用?

  1. 確保品質:避免錯誤程式碼進到 main 分支。
  2. 知識分享:團隊成員可以互相學習、討論。
  3. 一致性:保持程式風格一致,讓專案更整齊。
  4. 培養習慣:學會給建設性意見,而不是單純批評。

了解 Code Review 的背景後,我們要開始今天的實作!


實作流程
步驟 1:準備一個 Pull Request

先用昨天學的方法,建立一個新分支並送 PR:

git checkout -b feature/add-contributor
echo "- Sharon" >> contributors.md
git add contributors.md
git commit -m "新增 contributors.md"
git push origin feature/add-contributor

到 GitHub → 建立 PR,標題設為「feat: 新增 contributors.md」。
https://ithelp.ithome.com.tw/upload/images/20250930/20169195lMgfmmG0lG.png

https://ithelp.ithome.com.tw/upload/images/20250930/20169195tJZiSSLqSF.png

步驟 2:模擬「Reviewer」進行 Code Review

在 PR 頁面,點選 Files changed。
滑鼠移到某行,會出現 +,點下去就能對那行留言。
https://ithelp.ithome.com.tw/upload/images/20250930/20169195RZIlUjGuWw.png

在進行留言的時候,盡量把需求完整提出且具體,
避免寫得太模糊,進而節省需要再次溝通的時間成本。
https://ithelp.ithome.com.tw/upload/images/20250930/20169195AMU3ZgW8hb.png

步驟 3:接受意見並修改程式碼
接下來,我們就依據收到的 review,
回到本地端,修改內容:

echo "- 更新日期:2025/09/26" >> contributors.md
git add contributors.md
git commit -m "更新 contributors.md,加入日期"
git push origin feature/add-contributor

回到 GitHub,你會看到同一個 PR 自動更新了。
這就是 PR 的版本疊加機制,
每次 push 新 commit,PR 就會同步。

步驟 4:Reviewer 再次檢查並合併

  • 如果 Reviewer 滿意,就會點 Approve,並選擇 Merge pull request。
  • 如果 Reviewer 覺得還需要修改,可以繼續留言。
    這個過程可能反覆幾次,直到程式碼符合標準為止。

明天我們會進一步學習 Issue 與 Project 管理任務,
讓專案有清楚的「待辦清單」與「進度看板」!!


上一篇
Day 18:保持 Fork 與原始專案同步(Upstream Remote)
系列文
Git 與 GitHub 入門日誌19
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言