Pull Request(PR)は、コードの品質を保ち、チーム全体で知識を共有するための重要なプロセスです。
PRのタイトルは、変更内容を簡潔に表現します。
feat: ユーザー認証機能の追加
fix: ログインフォームのバリデーションエラー修正
API クライアントのエラーハンドリング改善
ユーザー一覧ページのパフォーマンス改善
update
fix bug
変更
PR
PRの説明文は、プロジェクトに応じて適切な内容を記載してください。以下は参考例です:
## 変更内容
<!-- 何を変更したかを簡潔に説明 -->
## 変更理由
<!-- なぜこの変更が必要だったかを説明 -->
## 確認方法
<!-- レビュアーが動作確認できる手順 -->
## スクリーンショット(該当する場合)
<!-- UI変更がある場合はスクリーンショットを添付 -->
## チェックリスト
- [ ] ローカルで動作確認済み
- [ ] テストを追加または更新した
- [ ] ドキュメントを更新した(必要な場合)
- [ ] Breaking Changeがある場合は明記した
.github/pull_request_template.md を作成すると、PR作成時に自動的にテンプレートが適用されます。
テンプレートの内容はプロジェクトごとに調整してください。PRは小さく保つことを推奨します。
プロジェクトのデフォルト設定として、以下を推奨します:
マージが完了したら、トピックブランチは削除します。
GitHubの設定で「マージ後に自動削除」を有効にすることを推奨します。