JetBrains Space ヘルプ

コードを確認する

Space を使用すると、あなたのチームがコードをレビューしたり、変更について話し合ったり、蓄積された知識を追跡したりすることが簡単になります。

Space のコードレビューは、1 つ以上のコミット、またはブランチ全体に関連付けることができます。コードレビューが開始されると、一意の ID を持つ別個のエンティティとなり、チームメイトがコードの特定の行についてコメントを交換したり、変更全般について話し合ったりできるようになります。

Space では、次の 3 つの異なるタイプのコードレビューを作成できます。

  • コミット後のコードレビュー。このコードレビューは、チームワークフローでリポジトリのトランク (メイン) ブランチへの直接コミットが必要な場合に使用できます。レビューを開始する前に、変更をコミットして Git リポジトリにプッシュする必要があります。

  • マージリクエスト。チームワークフローで、ベース (メイン、マスター) ブランチにマージされる前にコードをレビューする必要がある場合、機能ブランチにコミットし、このコミットに対してマージリクエストという特別なレビューを作成できます。このレビューに合格するとすぐに、Space から直接ブランチをベースブランチにマージできるようになります。

  • ファイルレビュー。このコードレビューを作成して、実際に変更を加える前に特定のファイルへの変更を要求することができます。このレビューが作成されると、コラボレーションプロセスは通常のコミット後のコードレビューと同じになります。

コードをレビューする理由

チームがコードをレビューする理由はたくさんありますが、ここではそのうちのいくつかを紹介します。

  • 変更をコミットしたため、同僚のチームメイトにそれを調べて、新しいコードが明確で読みやすく、重大な欠陥が含まれていないことを確認してもらいたいと考えています。

  • チームメイトの変化に潜在的な課題があることに気づき、それに彼らの注意を引きたいと考えています。

  • 機能ブランチに取り組んできましたが、コードをベースのブランチ (メイン、マスター) にマージする前に、コードをレビューして承認してもらいたいと考えています。

  • 重要な変更が行われるたびに、チームメイトにプロジェクトのステータスを常に最新の情報を提供したいと考えています。

ターンベースのコードレビュー

Space では、一般的なコードレビュープロセスには 2 人以上の参加者が関与し、次のロールに分けることができます。

  • 作成者は通常、自分のリビジョンに対してレビューをリクエスト(作成)するを行うコミッターであり、自分がコミットした変更を調査するために 1 人以上のレビューアーを招待します。

    実際に誰がレビューを作成したかに関係なく、コミット作成者は常にレビューの作成者とみなされます。

  • レビュー担当者は、作成者がコミットした変更を調査することが期待されています。参加者はコードの特定の行について話し合ったり、汎用コメントを追加したりできます。すべての課題が解決されるとすぐに、レビュー担当者は変更を承認します。

Space コードレビューのプロセスは、参加者が順番にプレイする戦略ゲームに似ています。Space を使用すると、自分が行動する番が来たことを知らせたり、他の参加者が作業を終えるのを待ったりすることができます。各参加者のステータスインジケーターは、その時点で誰の順番であるかを反映します。

コードレビューの例

作成者の Travis とレビュー担当者の Andrea という 2 人の参加者による典型的なコードレビューを見てみましょう。

Travis はリポジトリにファイルを追加し、Andrea にコードが課題ないかどうかを確認してもらいたいと考えています。

  1. Travis はコミットリストで自分のコミットを見つけ、そのコードレビューを作成します

  2. 次に、Travis は Andrea をレビュー担当者としてコードレビューに追加します。その結果、Travis のステータスは応答を待つに設定されます。これは、彼が Andrea からの応答を待っていることを意味します。

    codeReviewExample-1.png

    同時に、アンドレアにはレビューへのリンクが記載された通知が送信されます。今度は彼女の番です。

  3. アンドレアがレビューを開始します。彼女の現在のステータスは変更点の確認です。これは、彼女が行うことが期待されているためです。

    codeReviewExample-2.png

    レビューリストにアクセスすると、自分のレビューが必要ステータスの新しい項目が追加されていることがわかります。

    codeReviewExample-3.png
  4. アンドレアは変更タブに移動してコードを調べます。この段階で、Space は彼女に、すべてが課題なければ変更を受け入れるか、議論を開始してトラヴィスからの応答を待つかの選択を与えます。彼女はいくつかの課題に気づいたため、いくつかのコメントを書いて下書きとして保存しドラフトを提出するをクリックします。

    codeReviewExample-4.png

    アンドレアがドラフトを提出するに達すると、彼女が保存したコメントが送信され、ステータスが応答を待つに設定され、ターンはトラビスに戻ります。

  5. 現在、Travis のステータスはファイルの修正と表示されています。これは、Travis が応答し、コードにいくつかの改善を加えることが期待されているためです。Travis は Andrea のコメントに返信し、修正をコミットし、このコミットをレビューに添付します。ターンを完了するには、仕上げ作業をクリックします。

    codeReviewExample-5.png

    Travis のステータスが応答を待つに変わると、ターンは再び Andrea に移ります。

  6. アンドレアは修正をレビューします。今回はすべて課題がないようなので、「変更を受け入れる」をクリックします。これは、レビューを完了したことを意味します。

    codeReviewExample-5.5.png
  7. 再びトラヴィスの番です。彼は、アンドレアが変更を受け入れたことを確認し、彼にできることは何も残っていないため、Space はレビューを閉じることを提案します。

    codeReviewExample-6.png

    アンドレアまたはトラビスがすべてのディスカッションを解決済みとしてマークした場合、アンドレアが変更を受け入れた後、Space はレビューを自動的に終了したでしょう。

マージリクエストの例

関連ページ:

コードレビューを開始(リクエスト)する

チームメイトにコードレビューをリクエストする人は、通常、次の一連のタスクを実行します。変更をコミットしてプッシュするを Git リポジトリにコピーします。コードレビューを作成します。フィーチャーブランチへの変更をコミットし、それをベースブランチ (メイン、マスター) にマージしたい場合は、マージリクエストを作成します。査読者を招待するのフィードバックを待ちます。課題について話し合うがある場合は、査読者とコメントを交換すること、課題の解決に取り組み、修正をコミットし、新しいリビジョンを追加するを既...

マージリクエスト

作業中のブランチをベースブランチ (メイン、マスター) にマージする前に、チームメイトに変更を調べて承認するよう招待するマージリクエストを作成できます。マージリクエストは、次のことを可能にする特別な種類のコードレビューです。2 つのブランチを比較してください。競合がある場合は簡単に発見できます。ブランチをマージするはレビューページから直接アクセスできます (リベースとスカッシュも同様)。マージリクエストを作成する:コミットリストのグラフに従って、マージするブランチを見つけます。ブランチの最上位...

ファイルを確認する

ファイルレビュープロセスは、実際に変更を加える前に変更が必要な特定のファイルを特定できるため、通常のコードレビューとは異なります。これらの必要な変更がコミットされてコードレビューに追加されると、標準のレビューと承認プロセスに進むことができます。通常のコミット後のコードレビューは通常、コミット作成者によって開始されますが、ファイルレビューはコードの特定の部分への変更を提案したいチームメンバーであれば誰でも作成できます。通常、変更が行われた後にそれをレビューするのはその人です。ファイルレビューはいつ...

他の人が行った変更を確認する

レビュー担当者は通常、次の一連のタスクを実行します。レビューに移動して変更を調べます。フィードバックを残してディスカッションに参加してください。必要に応じて、他の参加者を招待します。変更を受け入れてレビューを完了します。誰かが変更をレビューするようにあなたを招待すると、レビューへの直接リンクを含む通知がチャット (レビュータブの下) に届きます。リンクをクリックしてレビューページに進みます。レビューページでは、ユーザーアイコンにステータスインジケーターが表示されます。オレンジ色で変更点の確認と表示...

コメントと提案された変更

すべてのコードレビュー参加者は、コメントを投稿してレビュー内で変更について話し合ったり、他の人が残したコメントに返信したりできます。マージリクエストをレビューするときに、コードを編集し、編集内容を提案として投稿することもできます。レビューページに投稿されたコメントは、専用チャンネルの参加者のチャットにも表示されます。ディスカッションが開始されたら、チャットまたはレビューから続行できます。すべてのコメントと返信は同期されます。コメントの種類:投稿できるコメントには次の 2 種類があります。レビュ...

リポジトリを検索する

ファイルを探す:リポジトリ内の特定のファイルを検索するには: プロジェクトに移動するをクリックして、検索するリポジトリを開きます。を押して、表示されたダイアログでファイル名の入力を開始します。コミットを見つける (リビジョン):リポジトリ内の特定のコミットを見つけるには: プロジェクトに移動するをクリックし、検索するリポジトリを選択します (複数ある場合)。コミット数タブに移動します。コミットリストの上部にあるコミットをフィルタリングするフィールドを使用すると、コミットメッセージに含まれる単語やフレ...