書籍 "Looks Good to Me"を読んでいたら,Chapter.6「Composing effective code review comments」にコメントプレフィックスのトピックがあっておもしろかった❗️大きく3種類紹介されていた.
- MoSCoW Comments
- Conventional Comments
- Comment Signals
僕自身はプルリクエストのレビューをするときによく (対応必須ではないです!)
/ [IMO]
/ [nits]
/ [typo]
などのテキストをコメントに含めるようにしていて,本書で紹介されていたコメントプレフィックスとニュアンスは同じなので,今後は Conventional Commentsなどよく知られたものに合わせようかな〜なんて考えながら本書を読んでいた💬
MoSCoW Comments
MoSCoW Commentsは Musts / Shoulds / Coulds / Woulds をコメントプレフィックスとして使う💡
Conventional Comments
Conventional Comments は有名な Conventional Commitsの「コメント版」って感じで
issue (non-blocking):
や suggestion:
や note:
などすぐに活用できそうなコメントプレフィックスとフォーマットが定義されている👌詳しくはウェブサイトを参照 \( 'ω')/
プルリクエストにコメントするときの共通的なプレフィックスとして使える Conventional Comments💬 Conventional Commits はよく使うけどその「コメント版」って感じ〜https://t.co/cUQcjc8wvs
— カック (@kakakakakku) 2025年2月3日
Comment Signals
そして,書籍 "Looks Good to Me"の著者が実際に MoSCoW Comments と Conventional Comments を使ってみたところ課題を感じて,最終的に独自の Comment Signalsにたどり着いたという話も載っていた.Comment Signals は大きく5種類のコメントプレフィックスから構成されていて,確かに使いやすそうだな〜という印象だった😀
needs change:
needs rework:
align:
levelup:
nitpick:
GitHub の Saved replies 機能
例えば Conventional Comments の note:
だったら特に負担に感じることもなく入力できるけど,suggestion (non-blocking):
ってなると入力するのも少し大変だな〜と思う.そんなときは GitHub の Saved replies機能が便利❗️コメントプレフィックスに限らず,よく使うコメントスニペットを保存しておくことができる.
サンプルとして以下のように4種類 Saved repliesを保存しておく✔️
nitpick: note: suggestion (non-blocking): question:
そしてコメントを書くときに Saved repliesボタンもしくは Slash commandsから保存したコメントスニペットを呼び出せる❗️
まとめ
コメントプレフィックスと GitHub の Saved replies 機能を組み合わせは便利だ〜 \( 'ω')/