Conventional Comments

DRANK

『Looks Good To Me』を読んだ時に知った “Conventional Comments” というものがある。このフォーマットについて一度書いておきたい。Conventional Commentsはコードレビューをするときに書くコメントのフォーマットについての提案である。名前からわかるように、Gitのコミットメッセージのフォーマットとして有名な Conventional Commits にインスパイアされている。Conventional Comments ではコードレビューコメントに次のような基本構文を与える。<label> [decorations]: <subject> [discussion]Conventional Commitsと同様に、チームやプロジェクトの中で合意されたwell-knownなラベルのリストの中から選択することで、そのコメントの意図を明確にできる。Conventional Commentsは考え方としてはおもしろく、フォーマットは無駄がないものだと思いつつ、これがうまくいくかどうかはチームのラベル設計・定義のセンスに依存する度合いが強いように感じている。nitpick についてはそもそもnitpickなコメント自体ノイズなのでやめておきたい。なのでラベルも不要だろう。そんなラベルをつけるくらいならコメントしなければいいのだ。suggestion も意図が読みづらい。そ…