前言
如今 Git 與 GitHub 已經成為業界主流,有很大機率你的專案也會使用到它們來進行版本控制,這篇文章主要探討 GitHub 網頁版上其實有許多內建功能可以提高代碼審查的效率值得去了解。
由於 GitHub 是一款基於 Git 附加的服務,所以我們時常會輕視它的功能,但其實 GitHub 有許多不錯的功能卻不是那麼明顯,因此主要分享一些我認為有用但日常使用沒有查覺到的功能。
第一招:提交審核的方式
不知道你有沒有想過每次 GitHub 審查時 「Add single comment」 與 「Start a review」究竟差別在哪裡嗎?如果沒有特別翻查過文件還真的不知道這兩個按鈕用途差在哪,不都是提交審核嗎?
原來差別主要在於使用情境,如果你確定只有一則審核要提交那麼 Add single comment 就十分方便,但如果有多則審核要提交那麼最好選擇 Start a review 可以一次評論完再提交。
- Add single comment:快速提交一則評論。
- Start a review:添加多則評論,評論完再點擊 Finish your review 按鈕提交。
為什麼不能一則一則提交呢?因為每一次提交就會通知(甚至發郵件)給整個關注這則 PR 的人,如果審核的項目多或時間長,頻繁的通知還蠻惱人的。
第二招:代碼建議
有時候你希望在審核中提供一些代碼建議,就可以使用 Add a suggestion 功能(或是 ctrl + g
),就會出現一個 Markdown 的 Code Block,方便寫下建議,並且切換成 Preview 時會自動顯示與現有代碼的交互比對。
審核者在閱讀審核時除了得到更為具體的建議之外,也可以直接點擊 Commit suggestion > Commit changes 按鈕來直接套用建議。
第三招:多行審核
啟動代碼建議的 + 號按鈕其實是可以拖曳的,這樣就可以一次選取多行相關的代碼進行審核。