はじめに

ラベルを付けることでレビューのやり取りがスムーズにいくようになった、実体験に基づくお話しです。

背景

少人数かつベンチャーだったこともあり、コードレビューの文化がありませんでした。
人によってコードがバラバラで、知識の共有もできていませんでした。
そこでコードレビューを提案し、導入することにしました。
ただ、これまでのバックグラウンドの違いもあり、議論が終わらなかったり、命令口調だったりで以下のような問題が起きました😭
💔 チーム内の雰囲気が悪くなってしまった
💔 レビューが終わらずタスクの進捗が悪くなってしまった

そこで導入したのがHRTとラベルです。
今回はラベルについてお伝えします🤗

HRTについては以下の記事を見ていただけると嬉しいです。
コードレビューを単純に導入するだけでは問題が起きた話 - HRT（ハート）の精神を大切にしよう！

ラベルとは？

レビューの意図を正しく伝えるために、コードレビューにつける分類のようなものです。

ラベル	意味
must	必ず対応してほしい！
imo	自分の意見や提案、好み。自分ならこう書くけどどうかな？
nits	細かい指摘。インデントやタイポなど。
ask	質問や確認。コードの意味や背景が分からないから教えて！こういう理解でOK？
suggestion	提案。こうしたらどうかな？

なぜラベルが必要なのか？

どういう意図でコメントしているのかを伝えることができるので、コミュニケーションがスムーズになります。
必ず対応すべきものが明確になるので、急ぎの際などに最低限対応するなど、状況に合わせての対応が可能になります。

ラベルをバッジで表示する

見やすくなるので視認性をあげることができます。

ラベル	バッジ	構文
must		`![badge](https://img.shields.io/badge/review-must-red.svg)`
imo		`![badge](https://img.shields.io/badge/review-imo-orange.svg)`
nits		`![badge](https://img.shields.io/badge/review-nits-green.svg)`
ask		`![badge](https://img.shields.io/badge/review-ask-blue.svg)`
suggestion		`![badge](https://img.shields.io/badge/review-suggestion-blue.svg)`

便利ツール

Text Blaze
スニペット管理のブラウザ拡張機能です。入力を省略できるので超便利です。
以下の記事で登録方法を詳しく書かれているので参考になります。
プルリクエストへのコメントでは Text Blaze でラベルバッジをつけよう！

やってみた感想

ラベルをつけることでレビュアーの意図を理解しやすくなり、コミュニケーションがスムーズに行えるようになりました。
優先度も明確になり、状況に合わせて判断することができるようになり、レビューにかかる時間も短縮することができました👍

参考