はじめに
※6月25日に投稿予定でしたが、GitHub Actions のコードを変更したことで投稿できていなかったので、まとめて投稿します
こんにちは。アメリカ在住で独学エンジニアを目指している Taira です。
現在 railsでアプリ開発中ですが開発に苦戦しながら進めています。
前回の記事の続きで、開発をするうえでこれを導入することでかなり頭がすっきりしたうちの1つに Pull Request(以下PR) のテンプレートがあります。
今回はPRのテンプレートの作成について記事を書いていきたいと思います
配置場所とファイル名
GitHub で PR テンプレートを設定するには、以下の場所にファイルを設置する必要があります：
.github/PULL_REQUEST_TEMPLATE.md
- ディレクトリ名：
.github - ファイル名：
PULL_REQUEST_TEMPLATE.md
GitHub はこのファイルを自動的に検出し、PR 作成時にテンプレートを適用してくれます。
実際のテンプレート内容
以下は、実務でもそのまま使えるテンプレートです。変更背景・影響範囲・動作確認・テスト・デプロイ情報・チェックリストまで網羅しており、レビュアーの負担軽減にもつながります。
## 概要
<!-- この PR の目的・背景を 1～2 行で記載してください（例：バグ修正、UI改善、パフォーマンス向上など） -->
## 修正点
<!-- 主な変更点を箇条書きで記載してください（例：バリデーション追加、デザイン調整など） -->
-
## 影響範囲
<!-- この変更が影響する画面・機能・ファイルなどを記載してください（例：todo一覧画面、Userモデルなど） -->
-
## 動作確認手順
<!-- レビュアーが確認しやすいように、操作手順を具体的に記載してください -->
1.
2.
3.
### 期待結果
<!-- 上記の操作を行った際に、どう表示・動作すべきかを記載してください -->
-
### スクリーンショット（UI 変更がある場合）
<!-- 変更前後のスクリーンショットやGIFを貼ってください。なければ省略可能です -->
## テスト
<!-- 自動・手動を問わず、実施したテストの種類をチェックしてください -->
- [ ] 自動テストを追加／更新した（RSpec, Minitest 等）
- [ ] 手動での動作確認を行った
- [ ] CI（GitHub Actions）が正常に通過する
## レビューポイント
<!-- レビュアーに特に見てほしい点があればチェックを入れてください -->
- [ ] **機能**：仕様どおりに動作するか
- [ ] **コード品質**：可読性・保守性
- [ ] **セキュリティ**：権限・バリデーション・入力チェック
- [ ] **パフォーマンス**：処理速度やリソース使用量
- [ ] **CI**：GitHub Actions のワークフローが成功しているか
## デプロイ／運用
<!-- 該当する項目にチェックを入れて、必要に応じて補足してください -->
- **マイグレーション**：有／無（テーブル追加、カラム変更など）
- **環境変数の追加**：有／無（.envやGitHub Secrets等）
- **破壊的変更の有無**：有／無（既存データへの影響など）
## 関連
<!-- 関連するIssueやPRがあれば番号で記載してください -->
- Issue: #000
- 他 PR: #000
## チェックリスト（作成者用）
<!-- PR作成前に確認した内容にチェックを入れてください -->
- [ ] 自身で動作確認・コードレビューを完了した
- [ ] 不要なコメント・デバッグコードを削除した
- [ ] コミットメッセージがわかりやすく記述されている
- [ ] 関連Issueがリンクされている（あれば）
運用のポイント
- チーム内でテンプレートの使い方を事前に共有しておくことで、運用の統一がしやすくなります。
- チェックリストを活用することで、レビュー前のセルフチェックが習慣化され、レビュー品質の向上につながります。
- 不要な項目がある場合は削除・簡略化して運用に合わせてカスタマイズするのがコツです。
- UI変更時はスクリーンショットを添えるようにルール化しておくと、視覚的な確認がしやすくなります。
まとめ
PR テンプレートを導入することで、開発者・レビュアーの両方にとって負担を減らし、品質の高いコードレビューを実現できます。
私自身もテンプレートの導入により、「何を書くべきか迷う」「確認漏れがある」といった悩みが大きく減りました。
まだ導入していない方は、ぜひこの記事を参考に自分たちのプロジェクトに取り入れてみてください！