3
1

【GitHub】プルリクエストのコメントにつけるラベルバッジを返信テンプレートに登録しよう【PullRequest】

Last updated at Posted at 2024-03-06

ワイ「PullRequest立てたやで!」

開発者A「この部分、こうしたいよね」

開発者B「この部分、こうだな……」

ワイ「👀」

ワイ(Aさんが修正案きてて、Bさんが感想書いてくれてるみたいだ)


数時間後…

ワイ「よっしゃ!直したやで!!!」

開発者A「いや、その作業はこのPRでやらなくていいです。」
開発者B「ワイのはこのPRで対応してほしいやで。」

ワイ「」

ということにならないように、ラベルがついてると便利だよね!
@iganin san による記事:

Q. でも毎回手入力してない?

返信テンプレートが登録済みのSaved repliesの画面キャプチャ

Text Blazeのブラウザ拡張使えばいいじゃん?と思ったそこのあなた。
→ この記事は終了です。ありがとうございました😭

今回紹介したいものは「返信テンプレート」という機能です。
GitHubの返信テンプレートに以下のようなコードを登録しておくと、コメントを記入する際にGiHubの機能だけでバッジを挿入できます。

![must](https://img.shields.io/badge/review-must-red.svg)

🔧 設定方法

手順 備考
1 Saved repliesにアクセス ログイン後、ユーザ設定画面から行けます
2 「Add a saved reply」からテンプレートを登録 参考:プルリクエストへのコメントでは Text Blaze でラベルバッジをつけよう!
Add a saved replyセクションの画面キャプチャ

💡 使用方法

※ Issueでも同様に返信テンプレートは利用できます

手順 画面キャプチャ
1 任意のPullRequestを開く
2 指摘をしたいコードの行コメントテキストフィールドを開く
3 ctrl + .またはSaved repliesボタンを押下
4 テンプレートを選択
5 本文を追記してから「Add single comment」か「Start a review」を押下1する

以上です!

こういうラベルバッジ系はチームルールにしたいところ。
しかしながら、今の構造だとGitHubユーザそれぞれが設定するしかないのがお悩みポイントですね👀

返信テンプレートは全リポジトリ共通なので、関わっているチームや組織ごとにルールが決まってたら、テンプレートリストが長くなってちょっと大変です。
私の場合はルールとして明示されているチームに属したことはないのですが、一般的にどうなんでしょう🤔

IssueやPullRequestのテンプレートは.githubディレクトリにMarkdownファイルを置けば作れるので、将来的にはコメントのテンプレートもリポジトリに設定出来たり、organization単位で設定できるといいな~と思っています。

もし「それもうできるで!」ということであればツッコミお待ちしております😂🥒

  1. 個人的には「Start a review」でいくつかレビューコメントを書いてもらったあと後に、「Submit review」ボタンから pending になっているレビューコメントをまとめて送信するタイプが好きです📝
    世の中はどっちのほうが多いんでしょうか👀

3
1
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
3
1