概要

Parasoft 社のコードレビューは、レビューの準備、通知、追跡を自動化することによって、レビューをより実用的かつ生産的にすることを目的として開発されました。コードレビューは、更新されたコードを自動的に特定し、担当レビューアーにコードを割り当てます。そして、問題がクローズするまで各レビュー項目の進行状況を追跡します。これによって、チームは強力なレビュープロセスを確立し、確実にコードをレビューして発見したすべての問題を解決するようにできます。

Parasoft 社のコードレビューは、次の一般的なコードレビューワークフローをサポートします。

コミット後: カスタムソース管理インターフェイスを介してソースリポジトリ中のコードの変更を自動的に特定します。変更されたコードとレビューアーの定義済みマッピングに基づいて、レビュータスクが作成されます。
コミット前: レビューに出すファイルを選択してデスクトップからコードレビューを開始するか、あるいはローカルに変更されたすべてのソースコードを自動的に特定することができます。
タスク駆動型: 特定の Parasoft Project Center タスクに関連するファイルを選択してデスクトップからコードレビューを開始できます。選択したファイルがソース管理システムにコミットされているかどうかは関係ありません。

なお、コードレビューを使用するには、Team Server と少なくとも 1 つの Parasoft Test Server Edition が必要です。

ワークフローの概要

2 種類の重要なワークフローがあります。「デフォルト vs. 制限付き」そして「コミット前 vs. コミット後 vs. タスク駆動型」です。

デフォルト vs. 制限付き

制限付きワークフローでは、レビューアーは各問題を承認しなければなりません。レビューアーの提案に作成者が同意しない場合、作成者はその問題についてレビューアーと話し合う必要があります。

デフォルトワークフローはもっとオープンです。レビューアーからコメントを受け取った作成者は、コメントの内容をコードに適用するか、またはコードをそのままにしておくことができます。

コミット前 vs. コミット後 vs. タスク駆動型

コミット前

コミット前のコードレビューは、ソース管理に追加する前にコードをレビューしたい開発チームに適しています。新規のコードまたは変更済みのコードをレビューに出す準備ができたら、Parasoft Test からコードレビュー用テストコンフィギュレーションを実行します。すると、必要なレビューがレビューアーに自動的に通知されます。

コミット後

コミット後コードレビューは、ソース管理にコードがコミットされた後にコードをレビューしたい開発チームに適していいます。通常、コードレビュー用テストコンフィギュレーションは定期的に (たとえば 24 時間ごとに) 自動的に実行するようにスケジュールされます。ソース管理リポジトリをスキャンし、レビューが必要なコードがあった場合、その情報を Team Server に送信して担当レビューアーに配布します。このワークフローの場合、コードの作成者は、コードをレビューしてもらうために特別なアクションを取る必要がありません。ソース管理システムにコードをコミットするだけで十分です。コードレビュー用テストコンフィギュレーションを実行すると、必要なレビューが担当レビューアーに自動的に通知されます。

コミット前のプロセスでは、ソース管理システムにコミットする前に承認が必要なコードに対して、コードレビューパッケージが作成されます。コミット前のプロセスにおいて、作成者はパッケージが最終的に承認されたかどうかを必ず確認するべきです。承認を確認した時点で、作成者はファイルをコミットしてコードレビューパッケージをクローズすることができます。

コミット前プロセスでレビューのためにコードをサブミットするチームの中には、次の操作を行うためにコミット後の夜間スキャンの実行を好むチームもあります。

電子メールを生成し、割り当てられたコードレビュータスクについて作成者とレビューアーに通知する。
ソース管理にコミットされたがコミット前の処理でレビューのためにサブミットされなかったコードの変更を特定する。

ワークフローの詳細

次の図は、利用できる重要なワークフローを表しています。

コミット前ワークフロー

コミット後ワークフロー

ビルトインコードレビューテストコンフィギュレーション

Pre-Commit: ソース管理システムにコミットする「前」にコードをレビューしたいチームに適しています (「コミット前 vs. コミット後vs. タスク駆動型」を参照)。ローカルに追加または変更されたファイルをスキャンします。このテストコンフィギュレーションを使用するには、コードレビューの設定で [スキャナー実行中にユーザー補助を表示] チェックボックスをオンにし、適切なレビューアーを作成者が指名できるようにする必要があります。
Post-Commit (Template): ソース管理システムにコミットした「後」にコードをレビューしたいチームに適しています (「コミット前 vs. コミット後vs. タスク駆動型」を参照)。前日に変更されたすべてのプロジェクトファイルをスキャンします。このテストコンフィギュレーションは、複製してカスタマイズしてから使用しなければなりません (例えば作成者とレビューアーのマッピングなどをカスタマイズします)。詳細については、「コミット後コードレビュースキャンの構成と実行」を参照してください。
Post-Commit (Assign All): ソース管理システムにコミットした「後」にコードをレビューしたいチームに適しています (「コミット前 vs. コミット後vs. タスク駆動型」を参照)。前日に変更されたすべてのプロジェクトファイルをスキャンします。このテストコンフィギュレーションはカスタマイズせずに使用できます。ローカルコードレビューユーザーのマッピングを含みます。(あらゆる作成者について) スコープで発見されたすべてのリビジョンを現行ユーザーに割り当てます。

コードレビュータスク / ステータスレポート

「コードレビューの UI」で説明するように、コードレビューのタスクは GUI でレポートされます。コマンドラインまたは GUI からの解析で生成されたレポートの [コードレビュー] セクションにはコードレビューの詳細情報も表示されます。これらのレポートは、プロジェクトと作成者ごとにコードレビュータスクの概要を提供します。また、保留中の課題とコードレビュータスクについての情報も提供します。

例:

Page tree

コード レビューの概要

概要