はじめに
新人プログラマ応援 - みんなで新人を育てよう！
ということで、今月から社会人となり、エンジニアになる方も多いのではないでしょうか？
今月は上記イベントに合わせて初心者応援をキーワードとして記事を書いていこうと思います。
今回は初心者応援記事第3弾、新人の方がPRのクオリティを上げる為の方法を3つご紹介したいと思います。
その１：レビュー依頼前に差分を自己レビューする
まず1つ目は、自己レビューをしっかり行うという事です。
新人の方であれば、業務にも慣れなければならない状況で余裕もなく、確認が疎かになっていませんか？
これが原因で本来気がつく事ができた修正事項に気がつく事ができず、指摘につながるなんて事がよくあると思います。
余裕がない状況であればあるほど、急がば回れという言葉を思い出してみてください。
確認する時間は掛かりますが、指摘が減れば結果回収できる時間も多いはずです。
最初のうちはご自身の差分を３度見するくらいが丁度良いと思います。
指摘が減る事で心の余裕にも繋がるはずなので、是非レビュー依頼前に自己レビューをきっちり行う事をお勧めします。
その2：過去のPRをサッと確認する
2つ目ですが、過去のPRを確認するというものです。
これは同じ指摘を何度も貰わないようにする為の方法です。
細かい同様の指摘を何度ももらってしまうなんて事が新人の方ではありがちです。
最初のうちは指摘の数も多く、もらった指摘を全部覚えるのも大変ですよね。
そんな時は、レビュー依頼する前にサッと過去のPRを眺めてみると良いと思います。
合わせて同期の方のPRを見る事ができるようでしたら、それも良いと思います。
過去に受けた指摘をレビュー前のPRにも生かせるポイントがきっと見つかるはずです。
こうして同じ指摘をもらわないように意識していると、だんだん指摘の数は減っていくと思います。
指摘の数がなかなか減らない方は、是非過去のPRを参照してみてください。
その3：PRに補足コメントを残す
３つ目はPRに補足コメントを残すというものです。
これは不必要なコミュニケーションを減らし、PRのクオリティ向上に繋がります。
例えば、他の方のコードを見た時に現状に至った経緯を知る必要がある場面があると思います。
これをご自身のPRで考えてみてください。
仕様を知らない方がレビューをするとしたら、そのコードが正しいかどうかというのは、仕様によりますよね。
そうなると、そこでコミュニケーションが必要になりますが、予め情報を提示しておけばこのコミュニケーションは不要になります。
必要なコミュニケーションのみに注力出来ると、レビュワーも不要なコメントをする必要がなくなり、レビューのクオリティが上がります。
また、ご自身のコードを客観視出来るようになると、不具合や指摘につながるコードを見つけやすくなるという副産的なメリットもあります。
その1で自己レビューに関して挙げていますが、是非一度合わせてご自身のPRを客観的に見ていただく事をお勧めします。
さいごに
新人の方は提出するPRがなかなか通らず、悩む場面多いですよね。
コメントはコミュニケーションの一環ですが、数が多ければ多いほどご自身が虐げられているような気持ちになる方もいるかなと思います。
そんな時に少しでもPRのクオリティを上げる事ができれば、ご自身のメンタルを守る事にも繋がるはずです。
是非PRで悩んでいる方は上記３つの事項を実践していただければと思います。