16
9

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

レビュー砂漠に Badge という花を添えようZE★

Last updated at Posted at 2023-07-27

レビューやってて・・・レビューされたときのGitHubのコメント見て思うんだよね・・・

「感情がないぜ...」

Reviewdog とかの静的解析ですら 🐶 とかつけてこちらの感情を和ませようとしているのに...

「人間のレビューのほうがロボットに見えるぜ...」

そもそもレビューの目的はクオリティを高めることにあって仲良しクラブのようなものはいらないんだけど、それでも温度感って伝わりづらいし、なによりどうして欲しいのかが誤って伝わる可能性もある。

実際次のどれを指しているのかは、受け取り方が様々ですね。

1. 「2」とはどういう意味なのか、と「 質問 」をしている
2. 何を意味するのか分かりづらいので、なるべく直したほうが良いという「 細かい指摘 」をしている
3. ここは必ず直してほしいという「 修正 」を求めている

ある程度はコメントでカバーできるだろうし、must とか nits を入れれば「コメントの意図」も伝わると思う。(よく見たらまた "2" とか入れてな...数字に呪われてんのか?

けどね、ソースレビューは「こーしろ」「あーしろ」「ここはこーだ」など指摘が多く、実装者の尊厳を踏み潰していく作業。稲穂のようにレビューのたびに踏みつけては成長してくれるだろうが、果たして今の草食性の時代に耐えられるのか!?

私もペーペーだった時代、とある先輩からのレビューコメントに 「キモい、NG」 とだけ書いてあった時は絶望しかなかった。(もはや何が悪いのかすら伝わらない悪意の塊に感じた

Shields.io の Static Badge を使って、レビュー砂漠に花を添える

はい、心なしか文章まで優しさを感じさせますね

ただこの Badge を毎回コピーして使うのも大変ですよね?

そこで Text Blaze をつかって、コードスニペット化させよう

スニペット化させることで、レビュー時に即時 Badge を反映させることができるぜ!

表にまとめると次のとおり(私は暖色系は必須、寒色系は任意で分けてます

ラベル 対応可否 意味 バッジ
must 必須 必ず直してほしい must-badge
![must-badge](https://img.shields.io/badge/review-must-critical.svg)
want 任意 できればやってね want-badge
![want-badge](https://img.shields.io/badge/review-want-blue)
nits 必須 細かい指摘(スペースとか改行とか)だけどよろしく nits-badge
![nits-badge](https://img.shields.io/badge/review-nits-orange.svg)
typo 必須 タイポ(nitsでもいいけど nits typo と書くよりも分かりやすい) typo-badge
![typo-badge](https://img.shields.io/badge/review-typo-orange.svg)
ask 必須 (質問)確認させて ask-badge
![ask-badge](https://img.shields.io/badge/review-ask-yellow.svg)
imo 任意 自分ならこうするけどどう? imo-badge
![imo-badge](https://img.shields.io/badge/review-imo-green.svg)
next 任意 次でいいよ、Issue化 next-badge
![next-badge](https://img.shields.io/badge/review-next-skyblue.svg)
good 任意 これは良い実装だ! good-badge
![good-badge](https://img.shields.io/badge/review-good-success.svg)
memo 任意 とりかえず何かコメントするとき memo-badge
![memo-badge](https://img.shields.io/badge/review-memo-lightgrey)

最後に

今回はソースレビューで Text Blaze を使いましたが、これは他にも汎用性のある便利なツールなので、他の使い方はまたどこかで...

16
9
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
16
9

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?