GitHubのIssue・Pull Requestのテンプレート機能を使おう

  • 130
    Like
  • 0
    Comment

GitHubにIssueとPull Requestのテンプレート機能がつきました。("Issue and Pull Request templates" - GitHub)とても便利な機能なので、みなさんも使ってみてください。

ファイル配置場所

リポジトリ直下、もしくは.githubフォルダーへ特定の名前がついたファイルを配置することで、Issueを作成するときや、プルリクエストを行うときの説明テキストの記入テキストにに、自動でテキストが挿入されます

  • ISSUE_TEMPLATE.md - Issueを作成するときのテンプレート
  • PULL_REQUEST_TEMPLATE.md - PullRequestを作成するときのテンプレート

また、CONTRIBUTINGと名前のついたファイルを配置することで、Pull Request時のガイドラインとして示すことができます。

  • CONTRIBUTING.md - Pull Request時のガイドライン

※拡張子はなんでも良いようです。

github.png

▲GitHubのリポジトリにファイルを配置した例

ISSUE_TEMPLATE

  • ISSUE_TEMPLATE.mdファイルを配置すると、Issue作成時にの説明記入エリアにテキストが挿入される。

issue-template.png

PULL_REQUEST_TEMPLATE、CONTRIBUTING

  • PULL_REQUEST_TEMPLATE.mdファイルを配置すると、プルリクエストの説明記入エリアに自動でテキストが挿入される。
  • CONTRIBUTING.mdファイルを配置すると「Please review the guidelines for contributing to this repository.」と文字が表示される。guidelines for contributingの部分のリンクは、CONTRIBUTING.mdへのリンクとなっている。

pull-request-template.png

まとめ

IssueやPull Requestに記入して欲しい情報はある程度決まっているかと思います。今回のテンプレート機能を使うことで型が決まり、より見やすいIssueやPull Requestを作成することができるようになると思います。