はじめに
コードレビューをする際にバッジをつけることでレビューの温度感(絶対直してほしい修正なのか、提案なのかなど)が伝わるようにしています。今回はGitHub上でバッジの設定方法と私の設定しているバッジを紹介します!
バッジの設定の仕方
https://github.com/settings/replies から設定することができます。
Saved reply titleにバッジ名、Add your saved replyに後述する文章を書きます
呼び出し方
コメントをする際に呼び出すことができます
-
〼 (Slash commands)を選択
-
Saved replies を選択
Saved reply titleに名、Add your saved replyに後述する文章を書きます
設定しているバッジ
設定しているバッジは全部で11個です!
ask
![ask](https://img.shields.io/badge/review-ask-9b71ae.svg)
caution
[!CAUTION]
特定の行動のリスクやマイナスの結果についてアドバイスします。
> [!CAUTION]
> 特定の行動のリスクやマイナスの結果についてアドバイスします。
good
![good](https://img.shields.io/badge/review-good-success.svg)
imo
![imo](https://img.shields.io/badge/review-imo-yellow.svg)
must
![must](https://img.shields.io/badge/review-must-critical.svg)
nits
![nits](https://img.shields.io/badge/review-nits-inactive.svg)
important
[!IMPORTANT]
ユーザーが目標を達成するために知っておく必要がある重要な情報。
> [!IMPORTANT]
> ユーザーが目標を達成するために知っておく必要がある重要な情報。
note
[!NOTE]
コンテンツを流し読みする場合でも、ユーザーが知っておくべき役立つ情報。
> [!NOTE]
> コンテンツを流し読みする場合でも、ユーザーが知っておくべき役立つ情報。
tip
[!TIP]
物事をより良く、より簡単に行うための役立つアドバイス。
> [!TIP]
> 物事をより良く、より簡単に行うための役立つアドバイス。
tweet
![tweet](https://img.shields.io/badge/review-tweet-9cf.svg)
warning
[!WARNING]
問題を回避するためにユーザーが直ちに注意を払う必要がある緊急情報です。
> [!WARNING]
> 問題を回避するためにユーザーが直ちに注意を払う必要がある緊急情報です。
おわり
他にもおすすめのバッジやコメントがあれば、教えてください!
参考
https://qiita.com/kamihork/items/be0d7bdad8ae5a8082fb
https://zenn.dev/ikarin0825/articles/c6a64678ed13ff