Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
Help us understand the problem. What is going on with this article?

プルリクでやられると嬉しいことまとめ

More than 3 years have passed since last update.

前回プルリクでやられると困っちゃうことまとめという記事を書いたのですが、これだけ読むとプルリク嫌いな人みたいな印象を与えてしまうような気がしてきたので、反対に嬉しいことをまとめてみました。
(プルリクを見ること自体はどちらかというと好きです。)

ではどうぞ。

ちょっと嬉しいこと

  • 「こんなプルリク出すので確認をお願いします」を口頭で言われる
  • 複雑な処理、イレギュラーな処理に対し、「なぜこんなことをする必要があるのか」がコメントされている

嬉しいこと

  • 指摘に対し、こうこうこういう意図があってこうしたのですがどうでしょうか、と前向きに議論してくれる

とても嬉しいこと

  • 自分の知らなかった技術が使われている。

解説

  • 「こんなプルリク出しましたので確認をお願いします」を口頭で言われる

気分的な問題なのですが、やはり無言でプルリクだけ投げられたりチャットで定型文投げられるよりは、直接言われた方が気持ちよくプルリクに臨めます。
どのくらいの細かさで見るのか、いつまでに見てほしいか、ざっくりどんな内容なのか、など、プルリクを見始める前に確認しておきたいことは結構いろいろあるので、それらをその場でさっと確認できるのも嬉しいです。

  • 複雑な処理、イレギュラーな処理に対し、「なぜこんなことをする必要があるのか」がコメントされている

「何をしているのか」よりも「なぜそうしているのか」がちゃんとコメントされていると、コードを読む側は助かります。
何をしているのかはコードを読めばよいので、「なぜ」が書いてあるそのコードがそこに書かれた意図が分かり、それが妥当なのかどうかを判断する大きな助けになります。

  • 些細な指摘に対しても、こうこうこういう意図があってこうしたのですがどうでしょうか、と前向きに議論してくれる

指摘する側も言い方にカドが立たないよう恐る恐る指摘していたりしますので、指摘に対し前向きに反応してくれると結構嬉しいです。
議論の結果、「確かにその通りだ。じゃあこのままで」となってもそれはそれで十分レビューとして成功だと思っています。
実装の意図を、実装した人だけでなくチームのメンバーが理解して説明できるようになることが重要だと思っています。

  • 自分の知らなかった技術が使われている。

やはり他の人のコードを見ていて一番楽しいのが、自分の知らない技術や考え方に触れることができたときです。
プルリクとして出されているということはある程度そのソースコードは機能している、ということですので、それを見ながら、不明点はググりながら自分の知識が増えていくのを実感することは、レビューをしていて一番楽しい時間です。本来の仕事を忘れて調べるのに熱中し、プルリクの続きを見るのを忘れることもあったりなかったり。。。

まとめ

やはりプルリクを見ていて自分にとってもプラスになった瞬間が一番嬉しいです。次にプロダクトやチームがより良い状態になったときでしょうか。(自分本位)

気力と時間と視力を消費してプルリクを見ている訳ですので、何らかのリターンがお互いにあることが理想的なプルリク(というかソースレビュー)なのではないかと思います。

chooyan_eng
フリーランスでアプリ開発や講師をやってます。Flutter, ネイティブでの iOSアプリ開発、Androidアプリ開発が最近のメインです。 https://zenn.dev/chooyan の方でも Flutter の仕組みを調べて説明する記事を書いています。開発、研修のお仕事はご相談ください。
https://tsuyoshichujo.com/
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away