GitHub上で使用する、Issues及びPull Requestsのテンプレートを登録することができる!
下記に作成方法を記載していきます!
Issuesテンプレートを作成する
リポジトリのルートディレクトリまたは.github
ディレクトリ内にISSUE_TEMPLATE.md
という名前のファイルを作成する。(拡張子はつけなくてもよい)
作成したISSUE_TEMPLATE.md
にマークダウン形式でテンプレートとして仕様したい内容を記述する。
書き終えたらコミット!
IssuesタブでNew issueを押下する
先ほど記述したテンプレートが適応されていればOK!
Pull Requestsテンプレートを作成する
Issuesテンプレート作成時と同様の手順で作成できます!
リポジトリのルートディレクトリまたは.github
ディレクトリ内にPULL_REQUEST_TEMPLATE.md
という名前のファイルを作成する。(拡張子はつけなくてもよい)
作成したPULL_REQUEST_TEMPLATE.md
にマークダウン形式でテンプレートとして使用したい内容を記述する。
pull requestを作成できる状態で、
CodeタブでCompare & pull requestを押下する
先ほど記述したテンプレートが適応されていればOK!
おわりに
すごく簡単ですね笑
IssueやPull requestは人によって書き方がバラバラだったりするので、フォーマットが統一されていた方が見易いですよね!
フォーマットがしっかりしていれば、対応漏れなども回避できると思います!
ただ、このテンプレート機能はIssueで一つ、Pull requestで一つしか作成できないので、「バグ報告」の場合にはこのテンプレート、「タスク」の場合にはこのテンプレートレートを使いたい!などという運用方法はできません。
その点を補っている良い記事がQiitaにありましたので参考に貼らせていただきました。