Table of contents
執行程式碼審查
行動編號： GGI-A-44。
描述
程式碼審查，是一項日常任務，涉及在發佈產品或交付專案給客戶之前，對應用程式的原始碼進行手動和/或自動檢查。在開放原始碼軟體的情境中，程式碼審查不僅僅是機會性地捕捉錯誤，而是一種在團隊層面執行的協作開發整合方法。
程式碼審查應適用於內部開發的程式碼以及從外部來源重複使用的程式碼，因為這能提升對程式碼的整體信心並強化所有權。此外，這也是一個絕佳的機會來提升團隊的整體技能與知識，並促進團隊協作。
機會評估
程式碼審查在組織開發軟體或重複使用外部軟體元件時都非常有價值。在開放原始碼的背景下，程式碼審查雖然是軟體工程流程中的標準步驟，但它也帶來特定的優勢，例如：
- 發佈內部原始碼時，確認遵守適當的品質指引。
- 貢獻至現有的開放原始碼專案時，確認符合目標專案的指引。
- 公開的相關文件已適時更新。
這也是分享並強化公司法律合規政策規則的絕佳機會，例如：
- 絕不可移除重複使用的開放原始碼中的現有授權標頭或著作權聲明。
- 未經法律團隊事先許可，不可從 Stack Overflow 複製與貼上原始碼。
- 在需要時正確地引用註明著作權條款。
程式碼審查將為程式碼帶來信任與信心。如果人們不確定使用軟體產品的品質或潛在風險，他們應進行同行審查與程式碼審查。
進度評估
以下檢驗要點顯示了此行動的進度：
- 開放原始碼程式碼審查被視為必要步驟。
- 開放原始碼程式碼審查已被計畫安排（定期或在關鍵時刻進行）。
- 已集體定義並接受執行開放原始碼程式碼審查的流程。
- 開放原始碼程式碼審查已成為開發流程的標準部分。
建議
- 程式碼審查是一項團隊合作的任務，在良好的協作環境下運作效果更佳。
- 請善加利用開放原始碼領域中現有的工具和模式，因為程式碼審查在該領域已是多年的標準做法。
資源
- 什麼是程式碼審查？(What is Code Review?)：Red Hat 的 Open Practice Library 提供的程式碼審查教學讀物。
- 程式碼審查的最佳實踐 (Best Practices for Code Reviews)：另一種對程式碼審查的有趣觀點。
建議的下一步行動
- GGI-A-26 - 貢獻至開放原始碼專案：程式碼審查是開放原始碼專案的常見做法，這有助於提升程式碼品質並促進知識共享。進行程式碼審查的貢獻者通常對外部貢獻與協作更感到自信。