🙌

レビュワーになって分かったこと

2023/04/07に公開

はじめに

フリーランスエンジニアのdaichiです。
普段はGo言語を中心に、バックエンドの開発をしています。

エンジニア4年目になってきたところで、レビュワーをやる機会が増えてきました。
そこで得た気づきをメモしていきます。

気づいたこと

1. コミットメッセージは重要

コミットメッセージから、どのコミットでどういう修正をしたのか、読み取ることが出来ます。
ここが「修正」または「fix」とだけ書かれていると、何をどこで修正したのか分からず、レビューがやりづらい場合があります。
具体的に、「何を」「なぜ」修正したのか書くと、非常にわかりやすいかと思います!

2. 差分が多すぎるとつらい

差分が多いと、人間なので、見落としもあると思いますし、何よりもレビュワーに負荷がかかって、一気に疲れます、、
差分は大きくても15くらいに留めておきましょう!
差分が大きくなりそうなら、タスクを分解して、小さくPRを出していく方が効率的かなと思います。

3. ネストが深いコードは読むのがつらい

個人的にネストが深いと、可読性が低くなってしまうと考えています。早期returnなどを活用することで、なるべくネストが浅いコードの方が、レビュワーへの負担が少ないと思います。

参考

https://zenn.dev/media_engine/articles/early_return

さいごに

まだまだレビュワー初心者ですが、よりよいサービスが作れるような実装が出来るよう、レビュワーとしても、スキルを向上させていきたいです!

Discussion