コンテンツにスキップ
開発ガイドライン
Esc
↑↓移動↵開く⌘Jプレビュー
このページの内容

Pull Request 運用

PR の作成タイミング、タイトルと説明文の書き方、サイズ、レビュー、マージ戦略

PR の作成ルール

作成するタイミング

Pull Request(PR)は、レビューを受けられる状態になったら作成します。 実装の途中で方向性を確認したい場合は、Draft PR(下書き状態の PR)で作成すると、早い段階でフィードバックを受けて手戻りを防げます。

タイトル

PR のタイトルは、Conventional Commits の形式で変更内容を簡潔に表現します。 develop へは squash マージするため、PR のタイトルがそのままコミットメッセージになります。

feat: ユーザー認証機能を追加
fix: ログインフォームのバリデーションエラーを修正
refactor: API クライアントのエラーハンドリングを改善
perf: ユーザー一覧ページの表示を高速化
update
fix bug
変更
PR

説明文

PR の説明文には、次の例を参考に、プロジェクトに応じた内容を記載してください。

## 変更内容

<!-- 何を変更したかを簡潔に説明 -->

## 変更理由

<!-- なぜこの変更が必要だったかを説明 -->

## 関連する課題

<!-- Closes #123 / Backlog の課題キー(PROJ-123) -->

## 確認方法

<!-- プレビュー URL と、レビュアーが動作確認できる手順 -->

## スクリーンショット(UI 変更がある場合)

<!-- 変更前と変更後のスクリーンショットを添付 -->

## 破壊的変更

<!-- ある場合のみ、影響と必要な対応を記載 -->

サイズ

1 つの PR には 1 つの目的だけを含めます。 差分はおおむね 400 行以内を目安にし、超える場合は分割してください。ロックファイルや自動生成されたファイルは行数に含めません。

大きな PR はレビューが困難になり、バグの見逃しや理解の誤りが発生しやすくなります。

レビュー

  • レビュアーの指定: PR の作成者がレビュアーを指定します。.github/CODEOWNERS を置いている場合は自動で指定されます
  • 確認すること: 変更内容が説明文と一致しているか、プレビュー環境で表示・動作に問題がないか、CI が成功しているか
  • マージする人: 承認を受けたら、PR の作成者がマージします
  • コンフリクトの解消: PR の作成者が、自分のブランチに develop を取り込んで解消します

マージ戦略

マージ方法は次のとおりにします。

  • トピックブランチ → develop: Squash and merge。作業単位を 1 コミットにまとめ、develop の履歴を読みやすくする
  • develop → main: Create a merge commit。どのリリースで何が入ったかを、マージコミットで追えるようにする
  • hotfix ブランチ → main: Create a merge commit(main の保護ルールで merge だけを許可している)
  • main → develop(hotfix の取り込み): Create a merge commit(緊急修正)

許可するマージ方法は、ブランチの保護ルールで制限します(ブランチ保護)。

マージ後のブランチ削除

マージが完了したら、トピックブランチは削除します。 Settings > General の「Automatically delete head branches」を有効にすると、マージ後に自動で削除されます。

このページは役に立ちましたか?