完美拉取請求的剖析
編寫乾淨的程式碼只是建立拉取請求時需要關注的眾多因素之一。
大型拉取請求在程式碼審查期間會導致大量開銷,並有助於在程式碼庫中引入錯誤。
這就是為什麼你需要關心拉取請求本身。它應該簡短,有一個好的標題和描述,並且只做一件事。
我為什麼要關心?
- 一個好的拉取請求將很快被審查;
- 它減少了將錯誤引入程式碼庫;
- 它促進了新開發人員的入職培訓;
- 它不會阻止其他開發人員;
- 它加快了程式碼審查過程,從而加快了產品開發。
拉取請求的大小
程式設計團隊的一項研究表明一個好的拉取請求不超過250行程式碼。
單一責任原則
就像類和模組一樣,拉取請求應該只做一件事。
標題和描述很重要
讓新人知道每一次的提交都做些什麼。
標題應該是不言自明的
例如標題:
“為 getEventTarget 新增測試用例”
“改進建立以小寫字母開頭的元件時的神秘錯誤訊息”
做一個有用的描述
描述更改的內容、為什麼會存在這個提交、明確它是做什麼的。