日々流れてくるブログを眺めていたら、「へんしんてんぷれーと？」という感じになってしまったので、使ってみることにしました
返信テンプレートとは
返信テンプレートとは、GitHub上でコードレビューやIssueに対するテンプレートのことです。テンプレートを作成することで、コードレビューの際によく使うコメントや回答をあらかじめ用意しておき、効率的にレビューを行うことができます。
最大100個まで登録できるみたいです
注意点
返信テンプレートは個人アカウントに紐づくことになるので、組織で統一的なフォーマットを提供することはできなさそうでした
テンプレートの作成
まずテンプレートを作成していきましょう。
GitHubページにアクセスして、設定画面を開きます。
Code, planning, and automation セクション内のSaved repliesをクリックします。
適当にタイトルやテンプレート内容を入力してAdd saved replyをクリック
作成されると上の方に表示されます
これで作成は終わりです。早速使ってみます。
テンプレートの使用
適当にプルリクエストを作成してコメント欄を開きます。
コメント欄上の右端にあるボタンをクリックして、先ほど作成したテンプレートを選択
無事にさっき作成したテンプレートの文面が挿入されました
テンプレートの編集や削除
作成した画面上で一覧から鉛筆マークをクリックすると編集。「X」ボタンをクリックすると削除することができそうですね。
どんなことに使う？
よくコードレビューで心理的安全性を高めるために、次のようなラベルをプレフィックスとして書いてやることがあると思いますが、この辺りから登録してみることにしました。
[MUST] (コメントする際はこれ以降のコメントを削除してください) ・必ず直して欲しいもの ・「Request changes」を選択する
[IMO] (コメントする際はこれ以降のコメントを削除してください) ・こういう風に書いた方がいいという個人的な意見が強め ・取り入れるかどうかはレビュー依頼側に任せる
[Suggest] (コメントする際はこれ以降のコメントを削除してください) ・IMOよりも客観的に推奨する
[NIST] (コメントする際はこれ以降のコメントを削除してください) ・TYPOやコーディングスタイルの軽微なミス
[ASK] (コメントする際はこれ以降のコメントを削除してください) ・レビュー依頼側に質問
もっといろんな使い方ができそうなので、あれこれ工夫してみようと思います
