プルリクエストについて
メモ: プルリクエストを使う際には以下のことを念頭に置いてください:
- 共有リポジトリモデルで作業をしている場合、プルリクエストにはトピックブランチを使うことをおすすめします。 ブランチあるいはコミットからプルリクエストを送ることもできますが、トピックブランチを使えば提案した変更を更新する必要がある場合、フォローアップのコミットをプッシュできます。
- プルリクエストにコミットをプッシュする場合、フォースプッシュはしないでください。 フォースプッシュをすると、プルリクエストが壊れることがあります。
You can create pull requests on GitHub.com, with GitHub Desktop, in Codespaces, on GitHub for mobile, and when using GitHub CLI.
プルリクエストを初期化すると、あなたのブランチ(比較ブランチ)とリポジトリのベースブランチとの差異の高レベルの概要を示すレビューページが表示されます。 提案した変更の概要を追加したり、コミットによる変更をレビューしたり、ラベルやマイルストーン、アサインされた人を追加したり、個人のコントリビューターやTeamに@メンションできます。 詳しい情報についてはプルリクエストの作成を参照してください。
プルリクエストを作成したら、トピックブランチからコミットをプッシュして、それらを既存のプルリクエストに追加できます。 それらのコミットは、プルリクエスト内で時系列順に表示され、変更は"Files changed(変更されたファイル)"タブで見ることができます。
他のコントリビューターは、あなたが提案した変更をレビューしたり、レビューコメントを追加したり、プルリクエストのディスカッションにコントリビュートしたり、さらにはプルリクエストにコメントを追加したりできます。
提案された変更に満足したなら、プルリクエストをマージできます。 共有リポジトリモデルで作業している場合は、プルリクエストを作成し、あなたか他のユーザが、プルリクエストで指定したベースブランチにフィーチャブランチからの変更をマージします。 詳しい情報についてはプルリクエストのマージを参照してください。
リポジトリでステータスチェックが要求されているなら、必須のステータスチェックをパスしてからでないと保護されたブランチにあなたのブランチはマージできません。 詳しい情報については、「保護されたブランチについて」を参照してください。
プルリクエストをIssueにリンクして、修復が進んでいることを示すことや、誰かがプルリクエストをマージしたときにIssueを自動的にクローズすることができます。 詳しい情報については「プルリクエストのIssueへのリンク」を参照してください。
参考:
- プルリクエスト内のすべての古いレビューコメントの折りたたみと展開を切り替えるには、optionAltAlt を押しながら、[Show outdated] または [Hide outdated] をクリックします。 その他のショートカットについては「キーボードのショートカット」を参照してください。
- プルリクエストをマージする際には、変更を効率的に見ることができるようにするためにコミットを squash できます。 詳しい情報についてはプルリクエストのマージについてを参照してください。
ダッシュボードにアクセスすれば、作業しているかサブスクライブしている最近更新されたプルリクエストへのリンクを素早く見つけることができます。 詳しい情報についてはパーソナルダッシュボードについてを参照してください。
ドラフトプルリクエスト
ドラフトのPull Requestは、Organization及びレガシーのリポジトリ単位の支払いプランのGitHub Freeのパブリックリポジトリ、GitHub Team、GitHub Enterprise Server 2.17+、GitHub Enterprise Cloudのパブリック及びプライベートリポジトリで利用できます。
プルリクエストを作成する際には、レビュー可能なプルリクエストを作成するか、ドラフトのプルリクエストを作成するかを選択できます。 ドラフトのプルリクエストはマージできません。また、コードオーナーにはドラフトのプルリクエストのレビューは自動的にはリクエストされません。 ドラフトのプルリクエストの作成に関する詳しい情報については、「プルリクエストを作成する」および「フォークからプルリクエストを作成する」を参照してください。
プルリクエストに対するフィードバックをもらう準備ができているなら、ドラフトのプルリクエストにレビューの準備ができているとマークできます。 プルリクエストにレビューの準備ができているとマークすると、コードオーナーたちからのレビューをリクエストすることになります。 プルリクエストはいつでもドラフトに変換できます。 詳しい情報については、「プルリクエストのステージの変更」を参照してください。
比較とプルリクエストページのコミットの違い
比較とプルリクエストページは、次のような異なる方法で、変更されたファイルの diff を計算します。
- 比較ページには、head ref のヒントと、head およびベース ref の現在の共通の先祖 (マージベース) との diff が表示されます。
- プルリクエストページには、プルリクエストが作成されたときの head ref のヒントと、head およびベース ref の共通の先祖との diff が表示されます。 したがって、比較に使用されるマージベースは異なる場合があります。
参考リンク
- GitHub 用語集中のプルリクエスト
- ブランチについて
- プルリクエストへのコメント
- プルリクエストのクローズ