Skip to content

Instantly share code, notes, and snippets.

@ngtk
Last active December 31, 2016 13:43
Show Gist options
  • Select an option

  • Save ngtk/18f1bfc95064ee14be485b748451be96 to your computer and use it in GitHub Desktop.

Select an option

Save ngtk/18f1bfc95064ee14be485b748451be96 to your computer and use it in GitHub Desktop.
My Review Policy

My Review Policy

これは何?

コードレビューでのコミュニケーションを円滑にするために自分の方針を明確にするためです。この文章ではレビューイ、レビュワー双方の立場での振る舞い両方を示すものとします。

レビューの目的

  • 読みやすいコードを実現するため
  • ロジックの矛盾やケースの抜け漏れを見つけるため
  • セキュリティーの問題を回避するため
  • より良い実装を学ぶため

レビューワーさんへ

  • PRの変更差分はなるべく小さくしたいと思っています。変更差分が300行以上あり、独立した問題により分割可能な場合は指摘してもらえると嬉しいです
  • 読みづらいコードがあった場合でもコメントを書いてもらえると嬉しいです
  • コーディングスタイルはコミュニケーションコストを減らすためなるべく明示化、静的解析により自動化をするべきだと考えていますが、されていない場合はレビューにてコメントすることを推奨します

レビューイさんへ

  • レビューコメントは議論のためのコメントです。常に押し付ける意図はないので、「そもそも問題ではない」「より良い解決方法がある」などコミュニケーションをとりたいです
  • IMO(In My Opinion)と明記したものはあくまで自分の意見なので対応しなくても大丈夫です
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment