2023-10-22

GitHubの返信テンプレートでコードレビューを楽に

コードレビューで定型文を使用したい

  • GitHub の Pull request でのコードレビュー
    • 修正内容のレベル分けをする際にラベル付けをしたい
      • [MUST], [IMO]など
    • 毎回ラベルの表記や基準を確認するのが面倒
      • 事前に定義できないか
        • GitHub の返信テンプレートを使用する

返信テンプレートの作成

Settings > Saved replies

Add a saved replyで作成

add


返信テンプレートを使用

PR のコメント欄の矢印アイコンをクリック

事前に定義したテンプレートを選択

select

テンプレートがコメント欄に挿入されるので、あとは内容を編集するだけ

comment


返信テンプレートの編集

Saved replies の鉛筆アイコン > Edit saved reply


参考

https://docs.github.com/ja/get-started/writing-on-github/working-with-saved-replies/about-saved-replies