標準的なGitHub プルリクエストテンプレート

標準的なGitHub プルリクエストテンプレート

標準PRテンプレートは、GitHubリポジトリで最も一般的に使用されるフォーマットです。レビュアーに十分なコンテキストを提供しつつ、コントリビューターに過度な負担をかけないバランスを取っています。

テンプレート構造

## Description
<!-- 変更内容と関連するIssueの概要を記載してください。 -->

## Type of Change
- [ ] Bug fix (既存機能を壊さないバグ修正)
- [ ] New feature (既存機能を壊さない新機能追加)
- [ ] Breaking change (既存機能が期待通りに動作しなくなる修正/機能)
- [ ] Documentation update

## Checklist
- [ ] プロジェクトのスタイルガイドラインに従っている
- [ ] コードのセルフレビューを実施した
- [ ] 修正が有効であること、または機能が動作することを証明するテストを追加した
- [ ] 新規・既存のユニットテストがローカルで通過する

## Testing
<!-- 変更を検証するために実行したテストを記述してください。 -->

## Related Issues
<!-- Fixes #(issue number) -->

主要セクションの解説

Description はHTMLコメントを非表示のプレースホルダーテキストとして使用します。コントリビューターは編集時にガイダンスを確認でき、レビュアーは提出後にクリーンなMarkdownを見ることができます。

Type of Change はGitHub Flavored Markdownのチェックボックス構文（- [ ]）を使用します。コントリビューターはスペースをxに置き換えるか（- [x]）、GitHub UIでレンダリングされたチェックボックスをクリックして直接チェックできます。

Checklist はレビュー前にコード品質ゲートが満たされていることを確認します。スタイル準拠、セルフレビュー、ドキュメント更新、テストカバレッジなどの一般的な項目が含まれます。

ファイルの配置場所

このファイルをリポジトリルートの.github/pull_request_template.mdとして保存します。GitHubは新しいPR作成時に自動的に読み込みます。テンプレートの内容がPR説明フィールドに事前入力されます。

カスタマイズのヒント

• 「CHANGELOGを更新した」「データベースマイグレーションが後方互換性がある」などプロジェクト固有のチェックリスト項目を追加
• コーディング規約やコントリビューションガイドへのリンクを含める
• テンプレートは簡潔に — 長すぎるテンプレートはコントリビューターの記入意欲を削ぐ