Day 21:新手常問:一個 PR 該放多少東西?判準不是行數,是「出事時你想一次撤掉什麼」
SPEC 要不要獨立開、三個階段要不要合成一張——四個理由與一個反例,附三題自我檢查
本內容為程式設計新手與開發者提供 Pull Request (PR) 範圍判斷的實質指南。核心判準是「出事時你想一次撤掉什麼」,而非傳統的行數或工作量。文章深入探討 SPEC 文件應否獨立開 PR、多階段開發為何不應合成一張 PR,以及何時應將多個改動合併為一張 PR,並提供三個自我檢查問題,幫助開發者做出明智的工程判斷,避免過度切分或合併不當的改動。
重點摘要
- PR 的核心判準是「出事時你想一次撤掉什麼」,而非行數、時間或檔案數。
- SPEC 文件應根據其「求決策」或「記錄已定案」的性質,決定是否獨立開 PR。
- 多階段開發不應合成一張 PR,因撤銷粒度、部署風險、Review 品質及資料依賴不同。
- 當後一步的正確性依賴前一步產生的資料時,兩者必須分開提交 PR。
- 若多個改動是同一個決定的不同部分,且「只做其中一個」會留下明確破口,則應合成一張 PR。
- 開 PR 前應自我檢查:有多少未拍板決定、想撤掉的範圍、以及後續步驟是否依賴前一步資料。
- 避免過度切分 PR,若改動單純且無複雜性,可合併提交以減少固定成本。
章節
PR 範圍的核心判準
判斷 PR 大小的真正依據是「出事時你想一次撤掉什麼」,而非行數或工作量。
SPEC 文件是否獨立開 PR
根據 SPEC 是「求決策」或「記錄已定案」來決定是否獨立提交,以避免白寫程式。
為何多階段開發不應合成一張 PR
多階段開發應分開提交,考量撤銷粒度、部署風險、Review 品質及資料依賴等因素。
何時應將多個改動合成一張 PR
當多個改動是同一個決定的不同部分,且單獨實施會留下破口時,應合併提交 PR。
開 PR 前的三個自我檢查問題
提交 PR 前應依序檢查未拍板決定、想撤掉的範圍,以及後續步驟是否依賴前一步資料。
避免過度切分 PR 的考量
若改動單純且無複雜性,可合併提交以減少每張 PR 的固定成本,避免過度切分。
適合對象:程式設計新手、開發者及任何需要提交 Pull Request 的團隊成員。