MR報告資料テンプレート
このテンプレートは GitLab の
.gitlab/merge_request_templates/default.mdとして配置し、MR作成時に自動適用される。 レビュワーがこの報告資料のみでレビュー完了できる粒度 を必須とする。
GitLab MR テンプレート本体
以下をそのまま .gitlab/merge_request_templates/default.md にコピーして使用する。
markdown
## 対応Issue
- Closes #<Issue番号>
- Issue リンク: <!-- GitLab Issue の URL を貼付 -->
---
## 実装概要
### 変更の目的
<!-- なぜこの変更が必要か。Issue の要件をどう解決するか -->
### 変更内容
<!-- 何をどう変更したか。主要な変更点を箇条書きで記載 -->
-
-
-
### 技術的なアプローチ
<!-- 設計判断・アーキテクチャ上の選択理由を記載 -->
---
## 影響範囲
### 変更ファイル一覧
<!-- 主要な変更ファイルと変更内容の概要 -->
| ファイルパス | 変更種別 | 概要 |
|---|---|---|
| | 新規/修正/削除 | |
### 影響を受ける機能・画面
<!-- この変更によって影響を受ける他の機能や画面 -->
-
### 依存関係の変更
<!-- パッケージの追加・更新・削除がある場合に記載 -->
- [ ] 依存関係の変更なし
- [ ] 依存関係の変更あり(以下に詳細を記載)
---
## 動作確認結果
### 正常系の確認
<!-- 期待通りに動作することを確認した手順と結果 -->
| 確認項目 | 手順 | 期待結果 | 実際の結果 | 判定 |
|---|---|---|---|---|
| | | | | OK/NG |
### 異常系の確認
<!-- エラーケース・境界値などの確認 -->
| 確認項目 | 手順 | 期待結果 | 実際の結果 | 判定 |
|---|---|---|---|---|
| | | | | OK/NG |
### スクリーンショット / ログ
<!-- UI変更がある場合: Before/After のスクリーンショットを添付 -->
<!-- API変更がある場合: リクエスト/レスポンスのサンプルを添付 -->
<details>
<summary>スクリーンショット(クリックで展開)</summary>
#### Before
<!-- 変更前のスクリーンショット -->
#### After
<!-- 変更後のスクリーンショット -->
</details>
<details>
<summary>実行ログ(クリックで展開)</summary>(ログを貼付)
</details>
---
## テスト結果
### 自動テスト
<!-- CI で実行される自動テストの結果 -->
- [ ] 既存テストが全てパスしている
- [ ] 新規テストを追加した(追加した場合、以下に概要を記載)
| テストファイル | テスト内容 | 結果 |
|---|---|---|
| | | Pass/Fail |
### 手動テスト
<!-- 自動テストでカバーできない部分の手動確認 -->
| テスト項目 | 手順 | 結果 |
|---|---|---|
| | | OK/NG |
### テストカバレッジ
<!-- カバレッジに変化がある場合に記載 -->
- 変更前カバレッジ: <!-- 例: 80% -->
- 変更後カバレッジ: <!-- 例: 82% -->
---
## セルフチェックリスト
### コーディング規約
- [ ] プロジェクトのコーディング規約に準拠している
- [ ] lint エラーがない
- [ ] 不要なコメント・デバッグコードを削除した
- [ ] 変数名・関数名が適切で分かりやすい
### セキュリティ
- [ ] 秘密情報(トークン・パスワード等)がハードコードされていない
- [ ] ユーザー入力のバリデーション・サニタイズを実施している
- [ ] SQLインジェクション・XSS等の脆弱性がない
- [ ] 認証・認可の確認を行っている(該当する場合)
### パフォーマンス
- [ ] N+1クエリが発生していない
- [ ] 不要なAPI呼び出し・DB問い合わせがない
- [ ] 大量データ処理時のメモリ使用量を考慮している
- [ ] キャッシュ戦略が適切である(該当する場合)
### その他
- [ ] ドキュメント(README等)を更新した(該当する場合)
- [ ] 環境変数の追加がある場合、README/設定ドキュメントに記載した
- [ ] マイグレーションが必要な場合、手順を記載した
- [ ] 後方互換性を維持している(破壊的変更がある場合は明記)
---
## AI利用について
### 使用したAIツール
<!-- AI支援を利用した場合に記載。利用していない場合は「なし」 -->
| ツール名 | 用途 | 使用箇所 |
|---|---|---|
| <!-- 例: Claude Code --> | <!-- 例: コード生成、レビュー支援 --> | <!-- 例: src/utils/helper.ts --> |
### AI生成コードの割合
<!-- おおよその割合を記載 -->
- [ ] AI生成コードなし
- [ ] 1〜25%(部分的な補助)
- [ ] 26〜50%(半分程度)
- [ ] 51〜75%(大部分)
- [ ] 76〜100%(ほぼ全て)
### AI生成コードの検証
<!-- AI生成コードがある場合、どのように検証したか -->
- [ ] コードの内容を理解し、レビュー済み
- [ ] テストで動作確認済み
- [ ] セキュリティ観点で確認済み
---
## レビュワーへの補足
<!-- レビュー時に特に確認してほしいポイントや、判断に迷った箇所等を記載 -->テンプレート運用ルール
必須記入項目
以下の項目は 空欄でのMR提出を禁止 する(品質ゲートで自動検証):
- 対応Issue - Issue番号とリンク
- 実装概要 > 変更の目的 - 変更理由
- 実装概要 > 変更内容 - 変更点の箇条書き(最低1項目)
- 動作確認結果 > 正常系の確認 - 最低1件の確認結果
- テスト結果 - 自動テストまたは手動テストの結果
- セルフチェックリスト - 全項目をチェック済み
- AI利用について - 使用有無の明記
記入ガイドライン
| 項目 | 期待する粒度 |
|---|---|
| 変更の目的 | Issue要件との対応が明確であること |
| 変更内容 | 第三者が変更差分を見なくても概要を理解できる粒度 |
| 動作確認結果 | 再現手順を含み、レビュワーが追試可能であること |
| スクリーンショット | UI変更時は必須。Before/After形式を推奨 |
| 影響範囲 | 変更が及ぶ他機能を漏れなく記載 |
テンプレートの配置
.gitlab/
merge_request_templates/
default.md # 標準テンプレート(上記の内容)GitLab の設定で MR 作成時にデフォルトテンプレートとして自動適用される。