プル要求では、メイン コード ベースとは別のブランチで変更が提案されるため、他のユーザーはマージ前に変更を確認できます。 このクイック スタートでは、pull request への最も簡単なパスについて説明します。 ブランチを作成し、変更を行ってコミットし、pull request を開き、フィードバックに応答して、マージします。
GitHub Web サイトで、または上記のいずれかのタブを選択してGitHub CLIに従うことができます。
リポジトリを分岐またはフォークする
最初に、作業する分離された場所を作成します。
- GitHubで、変更を提案するリポジトリのメイン ページに移動します。
- 必要に応じて、書き込みアクセス権がない場合は、フォークが必要です。 右上隅にある [ フォーク ] をクリックし、手順に従います。 次に、フォークしたリポジトリで作業を続けます。
- ファイル一覧の上部にあるブランチ セレクター メニューをクリックします。 それはおそらく メインと言う。 新しいブランチ名を入力し、[ メインからブランチ の新しいブランチ名を 作成] をクリックします。
-
GitHub CLIを使用するには、最初にインストールする必要があります。 「GitHub CLI のクイック スタート」を参照してください。
-
リポジトリを複製します。 または、リポジトリをフォークし、同時にローカルに複製します。
-
リポジトリへの書き込みアクセス権がある場合は、リポジトリを複製します。
gh repo clone OWNER/REPO -
書き込みアクセス権がない場合は、最初にフォークを作成し、一度にすべての フォーク を複製します。
gh repo fork OWNER/REPO --clone
-
複製されたリポジトリ ディレクトリに移動します。
cd REPO -
新しいブランチを作成し、そのブランチに切り替えます。
git checkout -b YOUR-BRANCH-NAME
コードを作成または編集する
そのブランチで変更を行ってください。 最初のプル要求では、変更に重点を置いてシンプルな状態に保ちます。 pull request を小さくすると、確認が速くなり、マージが容易になります。
次のいずれかを試して変更を加えます。
- IDE またはテキスト エディターでファイルをローカルで編集します。
- GitHubで直接ファイルを編集するには、ファイルを参照して [] をクリックします。
頻繁にコミットする
小さな意味のあるコミットで作業を保存します。 各コミットには、スナップショットと変更を説明するメッセージが記録されます。
git add .
git commit -m "Describe your change"
git push --set-upstream origin YOUR-BRANCH-NAME
GitHubでファイルを編集し、コミットする準備ができたら、コミット メッセージを入力し、ブランチに直接コミットします。
- [ 変更のコミット]をクリックします。...
- [ コミット] メッセージ ボックスに、加えた変更の簡単な説明を入力します。
- 作業しているブランチを選択します。
- [変更の提案] をクリックします。
変更内容が追加され、ブランチにコミットされます。
pull request を開く
ブランチに提案する変更がある場合は、ベース ブランチに対して pull request を開きます。
- リポジトリのメイン ページで、[Pull requests](プル要求 ) をクリックし、[New pull request](新しい pull request) をクリックします。
- ベース ブランチの場合、main はおそらく既に選択されており、通常はマージするベース ブランチです。
- 比較分岐の場合は、変更を含むブランチを選択します。
- [Pull request の作成] をクリックします。
- 変更した内容とその理由を説明するタイトルと説明を入力します。
- レビューの準備ができている pull request またはドラフト状態の pull request を作成できます。
- レビューの準備ができたら、[ pull request の作成] をクリックします。
- 進行中の作業を共有するには、ドロップダウンを使用し、[ 下書きプル要求の作成] を選択します。
レビューの準備ができている pull request またはドラフト状態の pull request を作成できます。
-
レビューの準備ができている場合は、次の手順を実行します。
gh pr create -
進行中の作業を共有するには
gh pr create --draft
次に、プロンプトに従って、ベース ブランチ、タイトル、および説明を設定します。
同じブランチにさらにコミットすると、プル要求に自動的に追加されます。
レビューを要求する
[レビュー担当者] ボックスを使用してレビューを要求するには、リポジトリへの書き込みアクセス権が必要であり、リポジトリへの読み取りアクセス権を持つユーザーまたはチームにレビューを要求できます。 レビューを要求すると、ユーザーまたはチームに通知が届きます。 場合によっては、選択できるレビュー担当者候補が表示されます。
[校閲者] ボックスが使用できない場合は、次のことができます。
- pull request レビューに関するガイダンスについては、リポジトリの readme を確認し、その指示に従ってください。
- レビューを実行できるユーザーがわかっている場合は、ユーザーに連絡し、pull request へのリンクを共有します。
レビューに関するフィードバックに対処する
レビュー担当者は、プルリクエストがマージされる前に、コメントしたり、変更を提案したり、変更をリクエストしたりできます。
- 校閲者の提案を受け入れるには、[ 提案のコミット ] をクリックします (または、複数をバッチ処理して [ 提案のコミット] をクリックします)。
- より広範な変更を行うには、コードを編集し、新しいコミットを同じブランチにプッシュします。 pull request は自動的に更新され、すべてのチェックが再実行されます。
- 対処したら、各会話を 解決 済みとしてマークします。
マージとデプロイ
必要なレビューと状態チェックに合格したら、pull request をマージして、変更をベース ブランチに取り込みます。 変更をマージしない場合は、代わりに pull request を閉じてかまいません。
ヒント
リポジトリが異なると、マージの要件が異なる場合があります。 関連するガイダンスを確認し、その指示に従います。
- プル要求の下部にある [ プル要求のマージ] をクリックします。
- [ 確認 ] をクリックしてマージを完了します。
- (省略可能)ヘッド ブランチを削除して、リポジトリを整理します。
gh pr merge
プロンプトに従ってマージ メソッドを選択し、必要に応じてブランチを削除します。
次のステップ
最初の pull request の後、他のユーザーの作業を確認してみてください。 「プル リクエストをレビューするクイックスタート」を参照してください。