GitHub

【GitHub】プルリクエストテンプレートを使って作業効率を上げる

pull request template

どうも、京都のベンチャー企業に勤めているエンジニア、クウルス(@Qoo_Rus)です。

皆さん、GitHubのPull Requestを作る際にdescription(説明テキスト)を書きますよね。

私はホントの駆け出し、使い始めの頃、こんな感じでした。

人生で初めてチーム内で出したPull Requestのdescription

 

リモートでお世話になっている先輩エンジニアの方がこれを見て、

普段から同期的にコミュニケーションを取れてないメンバーもいるので、Pull Requestの Descriptionをもうちょい丁寧に書いたほうがいいです

と私にアドバイスをしていただきました。

このアドバイス以後、チーム内で以下の情報は丁寧にわかりやすくdescriptionで伝えようということに決定。

  • このPRで何を達成したいのか
  • 具体的に何の変更をしたか(ソースコード見る前に頭に入れたい情報)
  • なぜその変更をしたか
  • 特にレビューして欲しい箇所

 

このようなdescriptionのテンプレートを予め仕込んでおくことがGitHubでは可能で、書く内容のテンプレートが定まっていると便利ですよね。

というわけで、この記事ではPull Request Templateの設定方法についてお伝えしたいと思います。

設定は3分あれば完結するので、是非活用してください。

この記事の対象となる方
  1. Pull Request Templateの設定方法を知りたい
  2. GitHubを使ってのリモートワークの作業効率を上げたい

Create New Fileでテンプレートファイル作成

テンプレートを設定したいリポジトリで新規ファイルを作成します。

Create New File」から作成すれば楽ですね。

ファイル名は必ず PULL_REQUEST_TEMPLATE.md に設定しましょう。

さらに、リポジトリ直下ではなく .github ディレクトリの下に置くとリポジトリ直下の階層のファイルがゴチャゴチャせずに済んでいい感じです。

テンプレート内容を書きmasterブランチにコミット

テンプレートのテキストをmarkdown記法で用意します。

私はこんな感じで設定しています。

#このプルリクエストで達成したいこと

#具体的な作業一覧(変更理由も含めて)


#特に見て欲しいところ

テンプレートを書き終えたら、そのまま下にスクロールしてmasterブランチにコミットしてしまいましょう。

まとめ

詳しくPull Requestの説明をするクセをつける意味でも、自動でテンプレートを反映する仕組みはとても有効です。

実際にテンプレートを設定してからは、リモートの方でもレビューがしやすいような説明を心がけられるようになったのでオススメです。

こういった地味な部分も大切に仕組み化していくことで、作業効率を上げていきましょう!