AppCode 2023.1 ヘルプ

GitHub プルリクエストを操作する

プルリクエストは、オープンソースプロジェクトや一部の企業のワークフローで、コントリビュータからの変更を管理したり、変更がマージされる前にコードレビューを開始したりするために使用されます。

プルリクエストを作成することで、元のリポジトリにプッシュしたい変更を他のユーザーに伝えることができます。これにより、そのリポジトリのメンテナーが変更を確認し、議論し、ベースブランチに統合できます。

プルリクエストを作成する

  1. メインメニューから Git | GitHub | プルリクエストの作成を選択します。プルリクエストツールウィンドウが開きます。

    Pull Requests tool window with a new pull request

    情報タブでは、左側のリポジトリが更新を受け取るベースリポジトリです。

    右側のリポジトリは、ベースリポジトリに追加される変更を含むヘッドリポジトリです。

    または、プルリクエストタブを開き、App Expui General Add Svg アイコンをクリックして、新しいプルリクエストを作成することもできます。

  2. 左側のベースリポジトリの名前をクリックします。開いたポップアップで、変更を適用するブランチを指定します。

    Base repository popup
    Base repository popup
  3. 右側のヘッドリポジトリの名前をクリックします。開いたポップアップで、適用する変更を含むブランチを指定します。

    Head repo popup
    Head repo popup

    複数のリモートリポジトリを使用するプロジェクトがある場合は、このポップアップでヘッドリポジトリも変更できます。

  4. プルリクエストの名前をタイトルフィールドに指定し、必要に応じて、リクエストによって適用される変更の説明を指定します。

  5. ファイルタブで、送信しようとしている変更を確認できます。任意のファイルの名前をダブルクリックして、差分ビューを開きます。

  6. コミット数タブで、プルリクエストに含まれるコミットのリストを確認します。

    コミットの詳細を表示するには、コミットをクリックして差分ビューを開きます。

  7. 必要に応じて、レビュアーを追加したり、プルリクエストを誰かに割り当てたり、プルリクエストにラベルを追加したりします。

  8. プルリクエストの作成をクリックします。

    プルリクエストをプッシュする準備がまだできていない場合は、ドラフトとして保存できます。

    • プルリクエストの作成ボタンの横にある App General Button Drop Triangle Svg ボタンをクリックします。

    • 開いたメニューで、プルリクエストのドラフトを作成を選択します。

    プルリクエストは、GitHub リポジトリにドラフトとして表示されます。メインメニューで Git | GitHub | プルリクエストを表示を選択すると、後で戻ることができます。

受信プルリクエストを管理する

プロジェクトのメンテナーであり、プロジェクト用に GitHub リモートが設定されている場合は、受信したプルリクエストを AppCode から直接表示および管理できます。

受信プルリクエストを表示するには、メインメニューから Git | GitHub | プルリクエストを表示を選択します。

GitHub Pull Requests tool window

GitHub プルリクエストツールウィンドウを使用して以下の操作を行います。

  • 状態別、作成者別、ラベル別、担当者別、レビューステータス別のリクエストのフィルター

  • GitHub でプルリクエストに移動する : プルリクエストを選択して、コンテキストメニューから GitHub で開くを選択します。

  • 提案された変更とベースリビジョン間のビューの差分 : プルリクエストの名前をクリックし、ファイルを選択してダブルクリックするか、Ctrl+D を押します。

  • 受信した変更に基づいたローカルブランチの作成 : プル要求を選択し、コンテキストメニューから新しいローカルブランチを作成するを選択します。

提案された変更を表示して適用する

元のリポジトリのメンテナが変更に関してコメントを残したり提案したりした場合は、AppCode から直接表示して適用できます。

  1. メインメニューから Git | GitHub | プルリクエストを表示を選択します。

  2. プルリクエストのリストで、操作するものを選択してダブルクリックします。

    AppCode は、選択したプルリクエストの概要を開きます。

    Tab with an overview of the selected pull request

    • タイトルの横にプルリクエスト番号があります。GitHub でプルリクエストを開きたい場合は、それをクリックします。

    • タイムラインの表示ボタンをクリックして、プルリクエストのタイムラインを開きます。

    • 変更されたファイルのリストをフィルタリングするには、からの変更点で調査するコミットを選択します。

    • 任意のファイルを右クリックして、このファイルのコンテキストメニューを開きます。

    • レビュー担当者がコメントや提案を残した場合は、ファイルのリストにコメント数のカウンターがあります。

  3. ファイルをダブルクリックして、提案された変更とコメントを表示します。

  4. コメントを解決するか、コメントに返信することができます。

  5. レビュー担当者が提案を残した場合は、コードと提案されたコードの違いが表示され、ローカルに適用(作業コピーにパッチを適用)またはコミット(コミットメッセージポップアップを開く)のいずれかを実行できます。

  6. プルリクエストの作業が終了したら、レビューを再リクエストしたり、プルリクエストをマージしたり、クローズしたりできます。

プルリクエストにフィードバックを送る

個別の行コメントを残すか、コード行に特定の変更を提案することができます。

コメントを残す

  1. プルリクエストを選択し、その中のファイルを開きます。

  2. ガターの App modules add content entry dark をクリックするか、Ctrl+Shift+X を押します。

  3. コメントをすぐに投稿するにはコメントを 1 つ追加を選択し、コメントを追加して一度に送信する場合はコメントでレビューを始めるを選択します。

  4. コメントを入力し、コメントをクリックして投稿します。

レビューを送信する前に、コメントに保留のマークが付けられ、編集できます。

提案を残す

  1. プルリクエストを選択し、その中のファイルを開きます。

  2. ガターの App modules add content entry dark をクリックするか、Ctrl+Shift+X を押してコメントを残します。

  3. コメントフィールドに、Markdown コードブロックでラップされているが、言語として suggestion が指定されているバージョンのコードを追加します。

    ```suggestion Your suggestion for this code line ```

    コメントと同様に、レビューを送信する前に提案を編集または削除できます。

レビューを送信する

コメントや提案を投稿した後、レビューを送信する必要があります。

  1. ツールバーのサブミットをクリックします。

  2. 考えられる結果の 1 つを選択します。

    After clicking submit, three options appear
    • 承認する : マージする変更を承認します。

    • 変更のリクエスト : フィードバックを送信するには、プルリクエストの作成者がマージする前に申請する必要があります。

    • コメント : 承認なしにコメントを送信します。