【GitHub】Pull Request テンプレートを使用する
【GitHub】Pull Request テンプレートを使用する
GitHub Pull Request テンプレートを作成して使用する方法。 これを使用することによってPull Request作成時、項目などの記載ブレが減ります。
テンプレートを作成する
以下のいずれかに作成すれば適用されます。
/.github/pull_request_template.md/docs/pull_request_template.md/pull_request_template.md
僕が作成したテンプレートは下記になります。
# Pull Request
<!-- Pull Requestのタイトル -->
## チケット
<!-- チケットがあればリンク貼る -->
## PRタイプ
<!-- Pull Requestの種類を選択 -->
<!-- 必要なものだけ残す -->
* 🆕新機能
* 🐛バグ対応
* 🧹リファクタリング
* 📖ドキュメント整備
* 💻開発環境
* 🚄インフラ
* ✅テスト
## 概要
<!-- Pull Request 概要・背景など -->
## 変更内容
<!-- 変更点 -->
## 影響範囲
<!-- 影響範囲 -->
## テスト
<!-- テスト手順 -->
<!-- テスト結果 -->
## その他
<!-- レビュワーへの注意点・相談内容・懸念点 -->複数のテンプレートを使用する
- 複数のテンプレートを格納するディレクトリを作成。
/.github/PULL_REQUEST_TEMPLATE/
- 複数のテンプレートを作成します。
/.github/PULL_REQUEST_TEMPLATE/template1.md/.github/PULL_REQUEST_TEMPLATE/template2.md
- Pull Requestを作成する。
- Pull Request作成時にURLの末尾に
?template=template1.mdを追加。 - 指定されたテンプレートを使用できる。