code-your-ruby icon indicating copy to clipboard operation
code-your-ruby copied to clipboard

レビュワーがレビューしやすくなるよう、レビューの方針を明確にする

Open chooyan-eng opened this issue 6 years ago • 5 comments

@ttanimichi さんより、

どこまで深くレビューすべきなのかなっていうのがふわっとしてて。あまり表面的なレビューだけしても価値が薄いでしょうし

とコメントいただいた通り、現状ではどのレベルでレビューをすればよいかの指針がないことによってレビューしづらい(何からツッコめばよいか分からない)状況になっています。

また、深いレベルでレビューしようとすると、それだけレビュワーの負担ばかりが増えてしまう問題、GitHub上でのやりとりでは限界がある点も課題となっています。

レビュワーがレビューしやすいために、何をどうすれば良いかを考えたいです。

chooyan-eng avatar Mar 02 '18 04:03 chooyan-eng

表面的なレビューの部分は @sideci とかで刈り取れるかもしれないですねえ

ttanimichi avatar Mar 02 '18 05:03 ttanimichi

考えられる解決策として、

  1. リポジトリとしてレビューの指針を決める
  2. プルリクを出すレビュイーごとに、どんな観点で見てほしいかを明記するようにする
  3. 各レビュワーが都合の良いレベルで自由にコメントする

あたりが考えられるかと思います。なお、現状はどちらかと言えば3の想定になっています。

chooyan-eng avatar Mar 02 '18 05:03 chooyan-eng

@ttanimichi SideCIは一度試してみたのですが、すべてのプルリクで「問題ナシ」と出てしまって挫折したことがありました、、、ただ、その時は「ちょっと試してみた」程度でしたので、もう少し研究してみます!

ちなみに今回レビューしていただいた @h5y1m141 さんのコードは、SideCIでひっかけられそうな指摘内容はありましたか?参考までに伺いたいです。

chooyan-eng avatar Mar 02 '18 05:03 chooyan-eng

うーん、どうなんですかね。 https://github.com/chooyan-eng/code-your-ruby/pull/5#discussion_r171495431 なんかは検知できても良い気がしたんですけど、どうなんだろ、SideCI に詳しくないので分からないです。。

ttanimichi avatar Mar 02 '18 05:03 ttanimichi

@ttanimichi なるほど!確かに、無駄に super 呼び出すだけのメソッドなら静的解析で分かりそうですね。 SideCIや、他に使えそうなツールがあるか、調査してみます。

chooyan-eng avatar Mar 02 '18 05:03 chooyan-eng