はじめに
エンジニアであれば、日常的に同僚にコードレビューを依頼することが多いでしょう。その中で、以下のような状況に遭遇したことはありませんか?
レビューを依頼する側の悩み:
「レビューを依頼したけど、ちゃんと気づいてもらえているかな?一声かけたほうがいいかも。」
「見てくれたみたいだけど、コメントを全部追加し終わったのかどうか分からない。」
レビューをする側の悩み:
「あのプルリク、承認したけどマージされたのだろうか?」
このような、コードレビューを依頼する側と受ける側のちょっとしたコミュニケーションのストレスを減らすために、業務の中で取り組んでいる方法を紹介します。
今回はSlackでレビューを依頼する場合を前提にした取り組みについて紹介します。
何をしたのか
ズバリ、、 スタンプ を使いました!!
こんな感じで、レビューを依頼するチャットにスタンプをつけていく方法を取っています。
以下、よく使用するスタンプとその詳細について説明していきます。
ちなみに、slackのスタンプは自作することができます。詳しい方法はこちらを参照してください。
対応します
使用場面:
レビュー依頼をされたことに気づいたが、今すぐにはレビューできないとき
伝えたい思い:
「いますぐにはプルリク見れないけど、あとで確認するから!レビュー依頼きたことには気づいてるから!!」
良い点:
このスタンプを押すことで、レビュー依頼を見逃しているわけではないことを示すことができ、レビューを依頼した側に「気づいてくれているんだ」という安心感を与えることができます。
レビュー中
使用場面:
依頼されたレビューを行なっている、まさにその時
伝えたい思い:
「今レビューしてる最中だよ〜!ちょっと待っててね〜」
良い点:
上記と同様、このスタンプを使うことで、レビューを依頼した側に「今まさにレビューしてくれているんだ」という安心感を与えることができます。
コメント追加
使用場面:
レビューがひと段落し、コメントを追加したとき
伝えたい思い:
「プルリク見たよ!気になるところコメントし終わったから見ておいて〜!」
良い点:
このスタンプを押すことで、レビューを受ける側はプルリクにコメントがついており、レビューがひと段落したことを知ることができます。
approved
使用場面:
レビューを終え、プルリクエストをapproveした時
伝えたい思い:
「Approveしたよ〜〜!お疲れ様〜」
メリット:
このスタンプを押すことで、レビューを依頼した人は誰がapproveを出したのかをチャットで簡単に確認できます。また、まだapproveを出していない人をすぐに把握できるため、再レビューの依頼もスムーズに行えます。
merged
使用場面:
プルリクエストをマージした時
伝えたい思い:
「このプルリクはすでにマージ済みだよ〜」
良い点:
このスタンプを押すことで、「あのプルリク、approveしたけどmergeされたんだろうか。。」というレビューする側の懸念を払拭することができます。これにより、レビューした側はプルリクが無事にマージされたことを確認でき、安心して次のタスクに移行できます。
まとめ
最後までお読みいただきありがとうございました。
どのスタンプも、 安心感を持って仕事を全うする 手助けになることがわかります。
些細なことではありますが、気持ちよく仕事をする上では非常に重要なことですので、仕組みや運用でカバーできることは徹底したいですね。
他にも「こんなスタンプ使ってるよ〜」や「こういうルールで運用するといいよ〜」などがあれば教えていただけると嬉しいです!