Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
コードレビューで大事にしたいこと
hayashiyoshino
February 27, 2022
Programming
0
340
コードレビューで大事にしたいこと
コードレビューで大事にしたいこと
hayashiyoshino
February 27, 2022
Tweet
Share
More Decks by hayashiyoshino
See All by hayashiyoshino
プロジェクトへ途中参加した際 早めにやっておくと良さそうな事
hayashiyoshino
6
800
How to be a better Rubyist
hayashiyoshino
0
1.9k
Other Decks in Programming
See All in Programming
ECテックカンファレンス2023
kspace
1
330
フロントエンドで学んだことをデータ分析で使ってみた話
daichi_igarashi
0
180
レガシーフレームワークからの移行
ug
0
120
Jetpack Compose 完全に理解した
mkeeda
1
460
domain層のモジュール化 / MoT TechTalk #15
mot_techtalk
0
110
フロントエンドで 良いコードを書くために
t_keshi
3
1.6k
(新米)エンジニアリングマネージャーのしごと #RSGT2023
murabayashi
9
5.7k
SHOWROOMの分析目的を意識した伝え方・コミュニケーション
hatapu
0
240
xarray-Datatree: Hierarchical Data Structures for Multi-Model Science
tomnicholas
0
210
PHPDocにおける配列の型定義を少し知る
shimabox
1
130
Hasura の Relationship と権限管理
karszawa
0
170
ECS Service Connectでマイクロサービスを繋いでみた
xblood
0
540
Featured
See All Featured
Rails Girls Zürich Keynote
gr2m
87
12k
From Idea to $5000 a Month in 5 Months
shpigford
374
44k
How GitHub Uses GitHub to Build GitHub
holman
465
280k
Large-scale JavaScript Application Architecture
addyosmani
499
110k
The Cult of Friendly URLs
andyhume
69
5.1k
Clear Off the Table
cherdarchuk
79
290k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
217
21k
Building an army of robots
kneath
301
40k
Building Your Own Lightsaber
phodgson
96
4.9k
Java REST API Framework Comparison - PWX 2021
mraible
PRO
13
5.4k
StorybookのUI Testing Handbookを読んだ
zakiyama
8
3.2k
Building Adaptive Systems
keathley
27
1.3k
Transcript
コードレビューで大事にしたいこと 2022/2/27 とにかくほめる!マウントなしのLT会 林 佳志乃
自己紹介 名前:林 佳志乃 所属:エーテンラボ株式会社 部署:サーバーサイド
None
テーマを選んだ背景 コードレビューで何を大事にすべきかなんとなく考えはあったものの、明確に なっていなく、そのせいでレビューにムラがあったり、優先度を間違えて後回 しにしてしまったりしていた これを機に明確にしておきたいと思った
コードレビューの目的 - コードの品質担保 - 実装者だけでなく他のメンバーも実装を理解する - 勉強
コードレビューで大事にしたいこと - issueやEPICに必ず目を通す - わからない箇所があれば質問する - 内容が難しい時はプルリク作成者に説明依頼する - 2開発日以内にレビューする -
レビューでは自分のことを棚上げする - ローカルまたは開発環境で動かしてみる
issueやEPICに必ず目を通す 仕様や機能の全体像が頭にないとコードを読むのに苦戦する 仕様を満たした実装になっているかをレビューするには、何のためにどんな機 能を作ろうとしているのか、どんな検討をしたのかを理解してからじゃないとで きない よっぽど小さな不具合修正などは別として、きちんとEPICやissueの内容を頭 に入れてからレビューを行いたい
わからない箇所があれば質問する よくわからない箇所がある場合は、自分の理解力の問題もあるが、コードに問 題がある可能性もある 自分の理解力がなかったケースでは質問することで勉強になる コードに問題があるケースではコードの品質担保になる
内容が難しい時はプルリク作成者に説明依頼する 内容が複雑だったり難しいときはレビューに時間がかかるし、億劫になって後 回しにしがち 効率よく理解して早くレビューをするために、内容が難しすぎる時は説明依頼を するようにしている 説明依頼は相手の時間を取ってしまい、申し訳ないな〜と感じたりするが、レ ビューまで時間がかかりすぎたり、ぼんやりした理解のままLGTM出すよりは 良いと考えている だいたい快く丁寧に教えてくれるし、一人で調べてレビューするより断然短時間 で理解が深まると感じている
2開発日以内にレビューする レビューする = 変更差分を一通り確認してコメント or LGTM する プルリクが滞留している時間が長いとリリースが遅れるし、rebaseが大変にな るし、健全じゃない 会社の開発メンバー間でのWorking
Agreementになっているが、私はあまりで きていない汗 これからはもっと2開発日以内のレビューを守っていきたい
レビューでは自分のことを棚上げする これも、会社の開発メンバー間でのWorking Agreementになっている 自分ができていないことを他の人に指摘するのは、申し訳ない気持ちになる が、コードの品質を保つためには自分ができていないことでも、気になったこと は指摘する必要がある チーム内で合意が取れていると少し気が楽 https://qiita.com/jnchito/items/0a0b46106681f41f2f0e の記事が、レビューで は自分のことを棚上げする大事さについて詳しく解説してくれている
ローカルまたは開発環境で動かしてみる プルリクだけ見ればレビューできそうな小さな変更でも、意外と問題を見逃して しまうことがある ローカルや開発環境で動かしてみて、「なんかレスポンスとして返る値が違いそ うだぞ」「うまく画面が描画されないぞ」などと気づくことがある
ご清聴 ありがとうございました