EN JP CN

コミット者の役割

コミット者の役割

コミット者の役割

コミット者の役割

コミット者であるユーザーは、SCM ツールでソフトウェアプロジェクトまたはソースコードを作成し維持する、ソフトウェアデベロッパーです。チェックインの前または後のいずれかで、SCM を設定しコードレビューを送信する責任があります。 コードレビューに他のユーザーを招待する責任もあります。コードレビュー中は、フィードを維持して監視し、レビュー担当者と連携して、すべてのコメント、アクションおよびレビューが適切に処理されるようにする必要があります。除外されたコードレビューは、そのコードを徹底的にレビューしてテストしてから、修正して再送信します。

コードレビューへの参加者の招待

コメントの追加やアクションの割り当てにはコードレビューへの招待は必要ではありませんが、特定の参加者を招待すると、その参加者の [実行予定] フィードにコードレビューが表示され、参加者がレビューの承認または拒否をできるようになることを意味します。

コードレビューまたはリビジョンの作成者またはプロジェクトルート管理者である場合は、右側に [レビュー担当者の招待] ボタンが表示されます。テキストフィールドで入力を開始し、オートコンプリート機能により、ユーザー名の候補が一覧表示されます。

レビューへのアクセスを制限したり、フィードをフィルターしたり、レビューのリストを検索したりするためにレビューをタグ付けできます。

チェックイン前のコードレビューを設定すると、レビュー担当者を招待できます。

特定の参加者を既に招待している場合、参加者のユーザー名およびアバターが [レビュー担当者の招待] テキストフィールドの下に表示され、次の 3 つのステータスのいずれかが表示されます。

  • 保留
  • 承認済み
  • 除外

トラブルシューティング:

  • レビューの作成者である場合、[レビュー担当者の招待] フィールドのみが表示されます。
  • レビュー担当者を招待する場合、参加者は既に Code Review にログインしているか、ソース制御にリビジョンを送信済みである (チェックイン後のレビューの場合) ことが必要です。そうでない場合、''ユーザー名は不明です'' というエラーメッセージが表示されます。
  • 1 人以上の参加者に、プロジェクトにアクセスするためのパーミッションがない可能性があります。コードを表示するときに "パーミッションが不十分です" というメッセージが表示された場合、Klocwork 管理者によるサポートが必要です。

ファイル履歴の表示

フィードビューまたはリビジョンビューで [履歴] をクリックし、選択したファイルに対するコメントまたはアクションなど、リビジョン間のファイルの履歴を表示します。履歴は、以前チェックイン前のレビューの一部であったファイルにも使用できます。

また、ファイルを履歴にある任意のリビジョンと比較することもできます。差分ビューの右上にある をクリックします。比較するリビジョンをドロップダウンリストから選択するだけで、右側に現在のコードが付いた以前のリビジョンが表示されます。

リビジョンの差分の表示

ファイルの差分を表示するには、フィードビューまたはリビジョンビューで、ファイルリンクをクリックします。

差分では、リビジョンの対照比較、または統合ビューのオプションがあります。差分ビューでは、右側にマーカーが表示され、1 つの変更から別の変更に移動できます。

書式の変更を無視し、コード自体に加えられた変更のみを表示する場合は、[W/S を無視] をクリックします。

ソースファイル全体を一度に表示します
1 つのファイルから別のファイルに移動します

差分ビューでは、次のことができます。

  • コメントの追加
  • アクションの割り当て
  • コードで検出された指摘の表示および更新
  • SCM リビジョン履歴でのリビジョンの比較

コードレビューの修正および再送信

送信したコードレビューをレビュー担当者が拒否した場合、指摘を修正して再送信し承認を求めることができます。最初のコードレビューに含まれるすべてのレビュー担当者は自動的に繰り越しされ、IDE またはコマンドラインでコードレビューが送信されると再度通知されます。

注: この機能は、チェックイン前のコードレビュー実行時にのみ使用できます。

IDE で修正コードレビューを送信するには、次の手順を実行します。

  1. [コードレビュー] ダイアログを開きます。
    • Eclipse:プロジェクトエクスプローラーでコードレビューに送信するプロジェクトまたはファイルを右クリックし、[コードレビューの作成] を選択します。
    • IntelliJ IDEA:([ローカル] タブの) [プロジェクトツール] ウィンドウまたは [変更ツール] ウィンドウでコードレビューに送信するプロジェクトまたはファイルを右クリックし、[コードレビューの作成] を選択します。
    • Visual Studio:ソリューションエクスプローラーでコードレビューに送信するソリューション、プロジェクト、またはファイルを右クリックし、[コードレビューの作成] を選択します。
  2. [コードレビューの作成] ダイアログが表示されます。
  3. Code Review のコードレビューで表示されるメッセージを入力します。
  4. 必要に応じて、コードレビューに 1 つまたは複数のタグを追加します。
  5. [リンク先] フィールドで、最初のコードレビューの ID を指定する必要があります。ID は [Klocwork フィード] ページ内にあるコードレビューのタイトルに記載されています。たとえば、'チェック前コードレビュー 89754' の場合、89754 が ID です。
    注: コードレビューの修正は 1 度しか送信できず、送信者は元のコミット者である必要があります。所有者でない場合や適切な権限を持っていない場合は、修正コードレビューを送信できません。
  6. リンク先のコードレビューを指定すると、元のコードレビューからのレビュー担当者はすべて自動的に追加されます。必要に応じて、レビュー担当者の名前を追加できます。
  7. プロジェクトツリーでは、ファイルまたはディレクトリを選択から除外できます (ただし、手順 2 で複数のファイルを選択した場合のみです)。
  8. [OK] をクリックします。
コマンドラインから修正コードレビューを送信するにはkwcodereview コマンドを使用して、適切なコードレビュー ID を含む --fix オプションを指定するだけです。コマンドは次のようになります。

kwcodereview --url http://server01:8080/zlib --message "Fixed code review 47865" --fix "47865" --tags myTag1,myTag2 cvs /path/to/project

検出された指摘の調査

コードレビューで許可されている場合は、チェックイン前のレビューで検出された指摘とそのトレースバック情報が表示されます。

この機能の詳細については、Klocwork Code Review の概要を参照してください。

検出された指摘は、「問題」としてフィードに次のように表示されます。

コードレビューでは、検出された指摘は次のように赤いボックスに表示されます。

指摘ごとに、次の項目が表示されます。

  • ステータス (ローカルで検出された指摘のみが表示されます)。上記の画像では、指摘のステータスは "検知 (Analyze)" です。
  • この指摘の以前のステータス (その履歴)
  • 指摘コード。これは、短い形式の検出された指摘のタイプです。上記の画像では、指摘コードは UNREACH.GEN です。クリックすると、特定の指摘に関するヘルプを取得できます。
  • 指摘の説明
  • 指摘が表示されるコードの行番号[行:] リンクをクリックすると、差分ビューが表示されます。

トレースバック情報を使用して検出された指摘を調査する

Klocwork では、検出された指摘の一因となった問題のあるステートメントに関する情報を提供します。 これを トレースバック と呼びます。

検出された指摘のトレースバック情報を表示するには、次のように [追跡] をクリックします。

表示されている検出された指摘の原因となったイベントと条件のマーカーおよびインラインの説明が表示されます。マーカーは行番号の上に表示され、関連するサマリーは赤色または青色のテキストでコメントとしてマーカーの向いに表示されます。たとえば、次のようになります。

アイコンの意味

追跡条件
追跡イベント
選択した追跡イベント

トレースバックの移動

  • トレースバックの条件とイベントで移動するには、[前へ] と[次へ] をクリックします。
  • 特定の追跡イベントのより詳しいビューを表示するには、[ステップイン] をクリックします。
  • ソースファイル全体を表示するには、ソースビューアーの上部または下部で [完全なソースを表示] をクリックします。

トレースバックツリー

トレースバックで複数行のコードが識別された場合は、トレースバックツリーを使用して、すべてのイベントおよび条件の概要を取得します。ツリーの各行は、ソースコードに直接リンクされ、実行順に従っています。

差分ビューに戻る

差分ビューに戻ってアクションを割り当てたりコメントを追加したりするには、次のようにビューの上部にある赤色のボックス内の行番号をクリックします。

指摘のステータスを変更して処理方法を表示する

指摘の調査が終了したら、そのステータスを変更できます。指摘ステータスは、指摘をレビューして処理方法を推奨したことを他の開発者に知らせる方法です。コメントを追加して詳細を提供すると、役立ちます。

この処理を "指摘の更新" と呼びます。

  1. 特定の検出された指摘の詳細を表示しているときに、左側のペインで [ステータス] ドロップダウンリストをクリックし、リストからステータスを選択します。

  2. [コメントの追加] をクリックし、コメントを入力して変更を説明します。
  3. [保存] をクリックします。コメントがユーザー名の横に表示されます。