GitHubのPRにテンプレが作れるって話

はじめに

GitHubのPR、皆さん十分活用されているでしょうか？

チーム開発を進めていると、ついつい書くのを面倒がってしまう自分がいますが...

チームメンバーのためにもPRはしっかり書いた方がいいんです。

PRを書く時間をいかに効率的に楽しく過ごすか…ということで

GitHubのPRを極めたいシリーズ第一弾、「GitHubのPRにテンプレが作れるって話」です。

基本の作り方

1. ローカルのリポジトリに .github ディレクトリを作成
2. .github配下にPULL_REQUEST_TEMPLATE.mdを作成
3. テンプレにしたい内容をマークダウンで記述していくだけ！

ここでは割愛しますが、複数のテンプレを作ることもできるらしいです！

詳しくはこちらの公式情報をご覧ください！

個人的最強PRテンプレの作り方

ここでは個人開発やチーム開発で経験した、私なりの最強テンプレをご紹介します。

PULL_REQUEST_TEMPLATE.md

# 関連issue
- close #1

# 説明
- xxx

# 対応
- xxx

# 動作確認
- xxx

# チェックするべきポイント
- xxx

(2024/09/07時点での最強 ver.)

解説

関連issue

GitHub指定の書き方をすると（例えばclose #<issueの番号>）PRが完了すると同時にissueを閉じることができます。

説明

コードで実装できたことや、修正した挙動の概略を説明します。

対応

追加したライブラリとその概略など、コード面でどのような変更があるのか記述します。

動作確認

プログラムを動かすためにはどのような手順が必要なのか記述します。

チェックするべきポイント

レビュワーに見てほしいポイントや相談を記述します。

おわりに

以上、「GitHubのPRにテンプレが作れるって話」でした！

まだまだ最強のPRテンプレには程遠いので、これからアップデートしていきたいと思います！