githubのテンプレートが予想上に便利だった話

概要

最近チームで導入したgithubのテンプレートがよかったので簡単にメモ書き程度に書き残しておく

プルリクエストのテンプレ化で目指したもの

以下、目指していたもの

レビュアーの負荷軽減のために予め作成しておいたテンプレートを
コピペすることで誰がプルリクを作っても常に同じレベルのものが出来る

目指した理由

• 作成するプルリクの情報の粒度が違った。
• 情報量に個人差がありレビュアーが何故これをするのか分からないケースがあった。

発生した問題

• 実際に上がってきた問題としてはコピペすらめんどくさいってこと。
• チーム内で扱っているサービスによりコピーするテンプレ変わるのめんどくさいですよね。

そんな時githubが公式でテンプレートを用意してくれた

• 原文はこちらです。
• 翻訳はこちらです。
  では、実際にデモリポジトリを作成したので作り方と使い方をメモしておきます。

実際にテンプレートを作成して利用してみる

テンプレートの作成方法

• 利用するリポジトリ内でNew fileをクリックします

• ファイル名は.github/PULL_REQUEST_TEMPLATE.mdにしました。

• テキストエリアはmd形式で好きなように書けます。

• ブランチを適当に切りました。

• プルリクを作成します。

• 現時点では何も書かなければNo description providedになります。

• demoなんで自分でマージしました。

• ブランチがなかったので適当なブランチを切りました。

• プルリクを作成してみるとテンプレートが予め読み込まれます。

結局なにがいいの？

• リポジトリごとにテンプレを管理できる
• テンプレ自体使ってみて不便だったら変更できる
• コピペという不毛な作業から開放される