談談_Code_review.pdf

Transcript

1. 談談 Code review 2021/06/10 F2E 例會 cypresskuo
2. Code review 的好處 • 分享知識 • 互相學習 • 程式碼的一致性 • 團隊成長 • 增加團隊向心力 • 提升程式碼品質
3. Code review 的壞處 • 增加成本 ◦ 時間成本 ◦ 溝通成本 • reviewer 標準太高會降低開發者改善程式碼的意願 • 凝聚團隊共識需時間（新團隊）
4. Code review 的基本原則 • 符合功能需求 • 可維護性 • 技術上的建議 • 遵守 style guideline • 維持程式碼的一致性 • 沒有規則可以參考時，以開發者選擇為主
5. Code review 在 review 什麼 • Design • Functionality • Complexity • Tests • Naming • Comments • Style • Documentation • Every line • Context • Good Things
6. Code review 的步驟 • 由大至小 ◦ 全局 ◦ 更動／新增的部份 ◦ 其他
7. 怎麼寫 Commit • 對事不對人 • 友善與尊重的語氣 • 充分說明 • 不要直接點出問題，保留思考空間給開發者 • 鼓勵
8. 面對回饋 • 寫 Code 的是開發者，不是 reviewer ◦ 有些問題只有開發者才知道，不能強硬要求改 Code • 不要怕被抱怨就降低標準
9. Code review 的衝突 • 不以個人主觀為主 • 只針對程式／數據 • 找出雙方都可以接受的解決方式 • 討論後務必做出決議
10. 結語 Code review 除了可以幫助團隊成長，也能幫助自己 Code review 除了提出意見外，也可以鼓勵開發者
11. 參考資料 https://google.github.io/eng-practices/review/
12. Q & A
13. 感謝聆聽