Helix Swarmガイド (2020.1)

レビューリスト

コードレビューリストを使用すると、以下のようなコードレビューの状況を確認することができます。

  • リクエスト済みでレビュー待ちのコードレビュー
  • 進行中のコードレビュー
  • 承認、却下、アーカイブされたコードレビュー

使用可能なすべてのレビューを表示するには、メニューで[レビュー]をクリックします。

[レビュー]ページに、Helix Coreサーバ内のすべてのプロジェクトについて、作業中のレビューと完了したレビューが一覧表示されます。

レビューページの画像

[作業状態]タブと[終了済み]タブには、以下の情報が表示されます。

  • [作業状態]タブには、すべての作業中のコードレビュー(開始されたコードレビュー、レビュー中のコードレビュー、リビジョン待ちのコードレビュー、コミットが必要なコードレビュー)のリストが表示されます。
  • [終了済み]タブには、すべての完了したコードレビュー(承認されてコミットされたコードレビュー、却下されたコードレビュー、アーカイブされたコードレビュー)のリストが表示されます。

各レビューでは、以下の情報が表示されます。

レビューの詳細の画像
  • レビューID
  • レビュー作成者のアバター
  • レビューの説明
  • 関連プロジェクト名およびブランチ
  • レビューが作成された日時、またはレビューが最後に更新された日時。どちらの情報が表示されるかは、[結果順]ボタンの設定内容によって異なります。
  • 24時間以上前のレビューの結果は、それぞれの日付で時刻順にソートされて表示されます。

    レビューのソートボタンの画像

    このソート順を変更するには、[結果順]ボタンをクリックし、ドロップダウンメニューで[作成済み]または[最後のアクティビティ]を選択します。

    • [作成済み]を選択すると、作成日時の順にレビューがソートされます。

    • [最後のアクティビティ]を選択すると、最終変更日時の順にレビューがソートされます。

    注意
    • [結果順]ボタンが表示されていない場合は、作成日時の順にレビューがソートされます。
    • [結果順]ボタンの表示設定は、Swarmの管理者によって制御されるグローバルな設定です。 詳細については、「レビューフィルタ」を参照してください。

  • 現在のレビュー状態を示すアイコン
  • レビュータイプを示すアイコン。 有効なタイプは、「プリコミット」と「ポストコミット」です。
  • レビューのテストスイートのステータス(テストが進行中の場合は テストが進行中であることを示すアイコンの画像、テストにパスした場合は テストにパスしたことを示すアイコンの画像、テストにパスしなかった場合は テストにパスしなかったことを示すアイコンの画像)を示すアイコン。
  • レビューに関連する作業中のコメント(アーカイブされていないコメント)の数を示すカウンタ。 コメント数の上にカーソルを置くと、レビューに関連するアーカイブ済みコメントの数が表示されます。
  • 賛成票および反対票の数を示すインジケータ
注意

アイコンの上にカーソルを置くと、ツールチップが表示されます。

プロジェクトグループには、それぞれのメンバーによって作成されたレビューを表示するための独自のレビューリストが存在します。

レビューのフィルタリング

コードレビューでは、以下のフィルタリングオプションを使用することができます。

  • ブランチ(プロジェクトの[レビュー]ページでのみ使用することができます): このドロップダウンメニューを使用して、現在のプロジェクトブランチに基づいて表示するレビューをフィルタリングすることができます。

    [ブランチ]ドロップダウンメニューの画像

    • すべて: 現在のプロジェクト内のすべてのブランチについて、すべてのレビューが表示されます。
    • ブランチ検索: この自動入力検索フィールドを使用して、現在のプロジェクト内の特定のブランチを選択することができます。 プロジェクトブランチを選択すると、そのブランチに関連するレビューのみが表示されます。
    • ブランチを選択: ブランチ名を選択すると、そのブランチに関連するレビューのみが表示されます。
  • プロジェクト: これは、プロジェクトに基づいてレビューをフィルタリングするためのドロップダウンメニューです。

    [プロジェクト]ドロップダウンメニューの画像

    • すべてのプロジェクト: すべてのプロジェクトについて、すべてのレビューが表示されます。
    • マイプロジェクト: メンバー、所有者、モデレータ、またはフォロワーとして自分が参加しているすべてのプロジェクトについて、すべてのレビューが表示されます。
    • プロジェクト検索: これは、自動入力検索フィールドです。このフィールドを使用して、Helixサーバで定義されているいずれかのプロジェクトを選択することができます。 このフィールドでプロジェクトを指定すると、そのプロジェクトのレビューのみが表示されます。 指定したプロジェクトIDを削除するには、[X]ボタンをクリックします。
    • プロジェクトを選択: プロジェクト名を選択すると、そのプロジェクトのレビューのみが表示されます。
  • ユーザ: これは、ユーザのレビューへの関わり方に基づいて、表示するレビューをフィルタリングするためのドロップダウンメニューです。

    [ユーザ]ドロップダウンメニューの画像

    • すべてのレビュー: すべてのレビューが表示されます。
    • 自分が作成したレビュー: 自分が作成したレビューが表示されます。
    • 自分が参加しているレビュー: 自分がレビュー担当者として参加しているレビューが表示されます(ただし、自分がそのレビューの作成者ではない場合)。
    • 自分が作成したレビューまたは自分が参加しているレビュー: 自分が作成したレビュー、または自分がレビュー担当者として参加しているレビューが表示されます。
    • 特定のユーザ: これは、自動入力検索フィールドです。このフィールドを使用して、Helixサーバで定義されているいずれかのユーザアカウントを選択することができます。 このフィールドでユーザアカウントを指定すると、そのユーザが作成したレビューのみが表示されます。 指定したユーザIDを削除するには、[X]ボタンをクリックします。

    上記のいずれかのオプションを選択すると、現在選択されているフィルタに一致するようにオプションリストが更新され、[ユーザ]ドロップダウンに現在のフィルタ([すべて][作成者][参加者]、またはユーザID)が表示されます。

  • レビュー担当者の有無([作業状態]タブの場合のみ):
  • [レビュー担当者あり]と[レビュー担当者なし]のレビューフィルタボタンの画像

    • レビュー担当者あり: 1人以上のレビュー担当者が存在するレビューが表示されます。
    • レビュー担当者なし: レビュー担当者が存在しないレビューが表示されます。

  • レビューの状態([作業状態]タブの場合のみ):

    [レビューが必要]、[リビジョンが必要]、[承認済み]のレビューフィルタボタンの画像

    • レビューが必要: レビューの変更を確認する必要がある状態です。
    • リビジョンが必要: レビューの変更の確認は完了していますが、その変更を承認する前に、追加のリビジョンが必要な状態です。
    • 承認済み: レビューの変更が承認され、コミットを待機している状態です。
  • レビューの状態([終了済み]タブの場合のみ):

    [レビュー状態]ボタンの画像

    • 承認済み: レビューの変更が承認され、コミットされた状態です。
    • 却下: レビューの変更が却下された状態です。
    • アーカイブ済み: レビューの変更がアーカイブされた状態です。
  • テストステータス:

    テストにパスした場合のレビューフィルタボタンの画像と、テストにパスしなかった場合のレビューフィルタボタンの画像

    • テスト合格: 関連するプロジェクトで自動テストが有効になっている場合、実行されるテストスイートにパスすると、Swarmではその結果に従ってレビューが更新されます。
    • テスト不合格: 実行されたテストスイートにパスしなかったという点を除き、[テスト合格]状態の場合と同じ動作になります。 テストが失敗した原因については、テストスイートを確認してください。
  • 投票ステータス:

    投票ステータスのレビューフィルタボタンの画像

    • 賛成票: 自分がレビューに賛成票を入れたことを示しています。
    • 反対票: 自分がレビューに反対票を入れたことを示しています。
    • 投票なし: 自分が参加しているレビューに投票しなかったことを示してします。
    • 投票のフィルタは、自分が参加しているレビューにのみ適用されます。 レビューにコメントを追加したユーザやレビューに投票したユーザは、そのレビューの参加者として自動的に追加されます。 レビューにコメントを追加した後でそのレビューから退出した場合、そのレビューはリストに表示されなくなります。

  • コメントステータス:

    コメントステータスのレビューフィルタボタンの画像

    • コメントあり: 自分がレビューにコメントを追加したことを示しています。
    • コメントなし: 自分がレビューにコメントを追加しなかったことを示しています。
    • コメントのフィルタは、自分が参加しているレビューにのみ適用されます。 レビューにコメントを追加したユーザやレビューに投票したユーザは、そのレビューの参加者として自動的に追加されます。 レビューにコメントを追加した後でそのレビューから退出した場合、そのレビューはリストに表示されなくなります。

  • ブックマーク: ページをブックマークすることにより、レビューフィルタをシステムに記憶させることができます。このアイコンが表示されている場合は、現在表示しているページがブックマークされています。
  • ブックマークボタンの画像

  • 検索語句: 入力した検索ストリングに一致するレビューの説明が検索されます。
  • レビュー検索フィールドの画像

Swarmは、ブラウザ内でURLを更新して、フィルタリングオプションを反映させます。 これにより、レビューリストのURLのブックマークと共有を簡単に行うことができます。 レビューリンクをクリックし、ブラウザの[戻る]ボタンを使用してレビューリストに戻った場合、Swarmでは現在のフィルタリング設定がそのまま表示されます。