他チームレビューのコツ

他チームレビューのコツ【KURAND社協賛】仕事とお酒を愛でる「ソースコード」レビューまつり！いっぬ（@yuyu_hf） 1

自己紹介いっぬ @yuyu_hf 合同会社DMM.comで認可領域のリードエンジニアをしています。副業の技術支援先でもリードエンジニアをしています。GoでサーバーサイドAPIの開発をすることが多いです。 2

今日LTするきっかけ第7回のDMM.goでDMM Platformのマイクロサービスを開発する各チームにGoのコードレビューのサービスを提供した話をしました。 Speaker Deck https://speakerdeck.com/yuyu_hf/dmm-go-7-microservices-go-code-review YouTube https://www.youtube.com/watch?v=6PT8jnGTOx4 3

今日LTするきっかけ発表内容を見た中西さんからLT会に誘ってもらいました。 LTでは他チームレビューするときのコツのみ話します。その他の内容は懇親会で話をさせてください。 4

他チームレビューするときのコツ自分が開発に携わっているプロダクトのコードレビューと他チームレビューでは目的が異なります。他チームレビューをするときはまず目的を決めて、目的に合わせてどのようにコードレビューするか決めます。 5

いぬさんが他チームレビューしたときの目的目的① チームの開発速度を上げる Goを使ったサーバーサイドAPIの開発に慣れていないチームに他チームレビューを提供し、チームの開発速度を上げる。目的② コード品質を上げる事業部全体で技術的負債の返却をしている途中なので、新規/リプレースするプロダクトが技術的負債にならないようにプロダクトのコード品質を上げる。 6

いぬさんの他チームレビューの制限制限・業務時間の内、週4時間 ~ 8時間を他チームレビューに使う・他チームレビューは、非同期のPRへのコメントで行う・基本的に他チームのMTGには参加せず、PRのレビューのみ実施する・他チームより自分のチームの仕事を優先する 7

コツ① レビューはベストエフォートで実施するいぬさんのチームで優先度の高いタスクがある場合、PRが作成されてからすぐに他チームレビューできません。いぬさんのコードレビュー待ちでチームの開発速度が下がってはいけないので、チーム都合でPRをマージしてもらいます。 8

コツ② 全部レビューしない他チームレビューのレビュアーは、レビュー先のチームメンバーに比べてプロダクトの仕様の理解が浅い。他チームレビューのレビュアーにプロダクトの仕様を十分に理解させようとすると、レビュアー/レビュイーの工数がかかる。プロダクトの仕様に関するレビューは基本的に諦めて、コードを読んだときに良いコードになっているかどうかでレビューをする。 9

コツ② 全部レビューしないレビューするもの例・Goの書き方・コードの書き方として品質が低いところレビューしないもの例・仕様の確認・テスト・CI/CDの仕組み 10

コツ③ レビューを具体的に伝えるメリデメを説明する通常のコードレビューと異なり、他チームレビューでは教育の観点でもレビューを実施します。レビューでコードの修正案を出すだけでなく、修正案を採用するときのメリデメを説明します。レビュイー自身がメリデメを考えながらコーディングできるようになることが目的です。 11

12 引用元: https://speakerdeck.com/yuyu_hf/dmm-go-7-microservices-go-code-review?slide=11

コツ③ レビューを具体的に伝えるサンプルコードを書くコードレビューではレビューした修正案に対して、レビュアーとレビュイーの間で変更後のコードに認識齟齬が発生しがちです。レビューした修正案と修正後のコードをセットでコメントすることで、認識齟齬が発生することを防ぎます。 13

コツ③ レビューを具体的に伝えるサンプルコードを書く 14 引用元: https://speakerdeck.com/yuyu_hf/dmm-go-7-microservices-go-code-review?slide=15

コツ④ 同期的レビューを併用する他チームレビューは非同期で行われます。他チームレビューに慣れていない人だと、説明しづらいレビュー内容をテキストコミュニケーションで説明しようとしがちです。説明しづらいレビュー内容は同期的にレビューするほうがレビュアー/レビュイー双方のコミュニケーションコストが下がる。 15

おわりいぬさんが他チームレビューを担当していたときに工夫していた点をコツとして紹介しました。他チームレビューにチャレンジする人はぜひ参考にしてください。 16

他チームレビューのコツ

他チームレビューのコツ

yuyu_hf

More Decks by yuyu_hf

Featured

Transcript