😺

新卒エンジニアがもらった今週のコードレビュー(3)

2024/06/02に公開

1.女の人とPRは丁寧に扱え

自分が作成したPRは、固有の仕様があるものに対して特に説明なしでPRを出してしまっていました。また、緊急度が高いものに関しては焦りすぎて、あろうことか何も書かずにPRを出してしまっていました、、
ここでいただいたレビューは、「何をしているかの説明が欲しい」というものでした、、そりゃそうだ、、
ついつい忘れがちになってしまうのですが、その作業をしているのは自分だけで、見る人は全員何のことかわからない状態でみます。わからないと質問するしかないので、結局時間がかかってしまいます、、
このレビューで、「どれだけ焦っていてもPRと女の人だけは丁寧に扱った方がいい」ということを学びました

2.とにかく他の人にわかりやすく

このレビューはいいところだったのですが、いい部分は続けていきたいのでまとめてみます。自分が作成したPRは、わかりにくい条件式をメソッドとすることで、何がしたいかを明示的にする、というものでした。さっきは説明を書いた方がいいと書きましたが、超究極はコードを見ただけでどんな機能で何がしたいかがわかる、ということだと思うので近づけるように頑張っていきたいと思います。

学んだこと

とにかく、人に読まれるということを意識してPRを作成することが大事だということがわかった。今週はリリース作業が多めで、PR自体少なかったがまだ見ぬ一発approveを目指して頑張ってこの記事を続けていきたい。(オールして書いているのでボケが少ない)

Discussion