良いコードレビューとは

Transcript

1. 良いコードレビューとは 2023-09-05 　社内 LT
2. このスライドは https://testing.googleblog.com/2023/08/testing-on-toil et-presents.html を意訳したものです。
3. テーマを選んだ理由 - 最近、レビューをする機会をいただいている - 一度レビューについて勉強しようと思ったため。
4. このようなコードレビューを 受け取ったことがあるかも
6. もしそうなら、おそらく頭を悩ませたことでしょう。 レビュワーはなぜこの質問をしているのでしょうか? 彼らはあなたを試しているのでしょうか？ 大きな間違いを犯しましたか？ 問題は、コメントが曖昧であることです（そして、おそらく少し失礼ですらあります）。 また、レビュワーが何を考えているかという重要な文脈が省略されているため、返答が 難しくなります。
7. レビュー コメントが効果的で、有 益で、明確なものであることを確 認するための簡単な方法をいくつ か紹介します。
8. 親切に あなたが敬意を持って接すると、人々はフィードバックをより受け 入れやすくなります。
9. 人ではなくコードに集中 コードではなく人を判断しているという印象を与える可能性がある 「あなた」という言葉を含む発言は避けてください。
10. コメントをする理由を説明 コードを書いた人には明らかではない代替案をあなたが知っているかも しれませんし、追加の制約を知っているかもしれません。
11. テスト採点者としてではなく、ガイ ドとして自分の役割に取り組む。 直接的なガイダンスを提供することと、作成者にある程度の自由 度を残すことのバランスをとります。
12. 優先度の低いコメントに Nit、 Optional、FYI などの重大度を付 ける レビューを受ける側が重要なコメントに優先順位を付けられるよう になります
13. コメントによっては、簡潔に表現するのが難しい場合があります。 微妙な API の使用法 や構造の変更 (たとえば、この大きな変更を小さな変更に分割する) など、書き換えを念 頭に置いている場合は、例を提供することを検討してください。 フィードバックを 2 回以上繰り返しても行き詰まった場合は、チャットやライブ通話など のより直接的なコミュニケーション チャネルに移行して、次のステップについて話し合う ことを検討してください。
14. ここまでを参考に最初のレ ビューを修正すると
16. ご清聴ありがとうございました