プルリクエストについて
メモ: プルリクエストを使う際には以下のことを念� �に置いてく� さい:
- 共有リポジトリモデルで作業をしている� �合、プルリクエストにはトピックブランチを使うことをおすすめします。 ブランチあるいはコミットからプルリクエストを送ることもできますが、トピックブランチを使えば提案した変更を更新する必要がある� �合、フォローアップのコミットをプッシュできます。
- Be very careful when force pushing commits to a pull request. Force pushing changes the repository history and can corrupt your pull request. If other collaborators branch the project before a force push, the force push may overwrite commits that collaborators based their work on.
You can create pull requests on GitHub.com, with GitHub Desktop, in Codespaces, on GitHub Mobile, and when using GitHub CLI.
プルリクエストを初期化すると、あなたのブランチ(比較ブランチ)とリポジトリのベースブランチとの差異の高レベルの概要を示すレビューページが表示されます。 提案した変更の概要を追� したり、コミットによる変更をレビューしたり、ラベルやマイルストーン、アサインされた人を追� したり、個人のコントリビューターやTeamに@メンションできます。 詳しい情� �についてはプルリクエストの作成を参照してく� さい。
プルリクエストを作成したら、トピックブランチからコミットをプッシュして、それらを既存のプルリクエストに追� できます。 それらのコミットは、プルリクエスト内で時系列� �に表示され、変更は"Files changed(変更されたファイル)"タブで見ることができます。
他のコントリビューターは、あなたが提案した変更をレビューしたり、レビューコメントを追� したり、プルリクエストのディスカッションにコントリビュートしたり、さらにはプルリクエストにコメントを追� したりできます。
提案された変更に満足したなら、プルリクエストをマージできます。 共有リポジトリモデルで作業している� �合は、プルリクエストを作成し、あなたか他のユーザが、プルリクエストで指定したベースブランチにフィーチャブランチからの変更をマージします。 詳しい情� �についてはプルリクエストのマージを参照してく� さい。
リポジトリでステータスチェックが要求されているなら、必� �のステータスチェックをパスしてからでないと保護されたブランチにあなたのブランチはマージできません。 詳しい情� �については、「保護されたブランチについて」を参照してく� さい。
プルリクエストをIssueにリンクして、修復が進んでいることを示すことや、誰かがプルリクエストをマージしたときにIssueを自動的にクローズすることができます。 詳しい情� �については「プルリクエストのIssueへのリンク」を参照してく� さい。
参考:
- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click Show outdated or 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 用語集中のプルリクエスト
- "About branches"
- 「プルリクエストへコメントする」
- プルリクエストのクローズ