概要
レビューコメントを残す際にラベルやアラートを付けるどのような指摘なのかがより明確に伝わり、対応するべきか、そのままでいいのか判断しやすくなります。
Gitシリーズ記事まとめ
各種機能紹介
Saved replies
公式で用意されている、IssueやPull Requestを書く際に使用できる返信テンプレートを管理できます。
Alert
マークダウン形式でアイコンと色で重要性を使い分けることができます。
Shields.io
公式の機能ではないですが、よくGitHubのREADMEなどにおしゃれなバッジを付ける時に利用されます。
返信テンプレートに登録する
こちらのリンクからテンプレートを設定します。
何でも登録できますが、私は下記の設定をしてます。ご参考にどうぞ
ラベルを使うのか、アラートを使うのかはぶっちゃけ好みだと思うので、自分が好きだと思う方を使ってみてください！
ラベル
絶対に修正して欲しい項目がある場合に使います。 Change Request と一緒に使います。
質問をして回答をもらいたいコメントをする時に設定しています。
In my opinion(私の意見では) の略で私ならこう書くかもという意見。取り入れるかはレビュワー次第でokくらいのニュアンス
nitpick(些細な指摘) typoや改行してないとか余計なスペースがあるとか。Approveするけど細かい部分を言いたい時に使います。特段返事も要らないよって時に使います。
良かった部分があったら積極的に利用しましょう。
ツイート、つぶやき。お気持ち表明したい時などに使います。
アラート
> [!NOTE]
> コンテンツを流し読みする場合でも、ユーザーが知っておくべき役立つ情報。
> [!TIP]
> 物事をより良く、より簡単に行うための役立つアドバイス。
> [!IMPORTANT]
> ユーザーが目標を達成するために知っておく必要がある重要な情報。
> [!WARNING]
> 問題を回避するためにユーザーが直ちに注意を払う必要がある緊急情報です。
> [!CAUTION]
> 特定の行動のリスクやマイナスの結果についてアドバイスします。
使い方
IssueやPull Requestでコメントを書くときの Saved repliesのアイコンから使用できます。
選択するとコメント欄にテンプレートが貼り付けされます。
使い方(コマンド)
GitHub上のコメント入力フォームへ / を打つとSlash commandsを呼び出せます。
Saved replies と入力する(saまで入力したら予測出てくる)と同じようにテンプレートを選択できます。
使い方(ショートカット)
GitHub上のコメント入力フォームで control + . でSaved replies を呼び出せます。