[PR] あなたが Kindle で読みたいその本、Kindle に対応したら Twitter でお知らせします。

LGTM に至った経緯を書くのが大切なワケ

Posted on

コードレビューをするときに最近意識していることを書いてみようと思います(社内の Qiita:Team に書いた内容をもとに加筆・修正しています)。

LGTM に至った経緯が知りたい

コードレビューの Pull requests でこういうコメントをよく見かけますよね。自分もしょっちゅう書いています。

LGTM

LGTM は "Looks good to me" の略で「良さそうだ」「問題ないと思う」という意味ですが、最近は LGTM に至った経緯を簡単でもいいので書くように心がけています。

たとえば、このコードレビューではどういうコマンドでチェックしたかを書いています。

LGTM とその経緯

LGTM とだけ書くのに比べれば少し時間はかかりますが、それ以上のメリットがあると感じています。

  • レビューのやり方が間違っていた場合に指摘してもらえる
    • 的外れなレビューをしていたときに、レビュイーが気付けるかもしれません
  • ノウハウが共有できる
    • レビューの視点は人によって異なるのでレビューが完璧とは限りません。経緯を書くことで暗黙知になりがちなノウハウが共有され、レビューの質が上がるかもしれません
    • もっと効率的なやり方やツールがあったら、レビュイーとレビュアーで情報交換ができます
  • 自分の備忘録になる
    • どういう考えでレビューをしたかは、あとから見返したときに貴重な情報になります。半年後の自分は赤の他人です

まとめ

コードレビューをするときに、ほんのひと手間をかけるだけでいろんなメリットがあるという話でした。