aqubi+shin1
 
Search this site

Recent site activity
eclipse‎ > ‎

jupiter-eclipse-plugin

ソースコードレビューのためのEclipsePlugin.

Contents

  1. 1 説明
  2. 2 使い方
    1. 2.1 レビューセッション用のJupiterの設定を作成する（初めてJupiterを使用するとき）。
    2. 2.2 レビューセッション用のJupiterの設定を作成する(二回目以降)
    3. 2.3 レビューコメントの追加
  3. 3 疑問

説明

以下の様なカンジのワークフローで使えると思われる。
  1. レビュー開催が決まる。
  2. プロジェクト内にJupiter用のレビュー用のID（例：myproject-20080625）を作成する。
    1. レビューの観点
  3. レビューセッション開催者（Author）がレビューのリソースを準備する。（Jupiter用のファイルも含めて）
    1. Auhor自身が、より注意して見て欲しいとかの要望を持っていれば、それもJupiterに登録する。
  4. Authorが準備したリソース一式（+Jupiter用のファイル）をリポジトリにチェックインする。
  5. レビューを開催する。
  6. レビュアーが、自分のマシンのEclipseへリソース一式をチェックアウトする。
  7. レビュアーは対象のリソース類を確認し、コメントがあればJupiterに登録する（レビュアー個人のEclipseで作業）。
  8. レビューが終わったら、レビュアーはレビュー結果をおのおのリポジトリにチェックインする。
  9. 全員のレビュー結果をチェックアウトし、レビュアーのコメントを整理する。
    1. 提案やダメだしに対するアクションはここで決定される。
    2. もちろん、問題なければ承認する。
  10. 整理した全員のレビュー結果を再度チェックイン・チェックアウトする。
  11. Authorはこれらの手順で決定されたアクションを消化する。

使い方

レビューセッション用のJupiterの設定を作成する（初めてJupiterを使用するとき）。

  1. EclipseにJupiterPluginをinstallする（更新サイトもある）
  2. Eclipseを再起動したら、「レビューテーブル」Viewを開く。
  3. PackageExplorerView上で対象のプロジェクトを選択し、「レビューの追加」ボタンをClickする。
  4. 図のようなDialogが表示されるので「レビューIDの作成」を選択する。
  5. 「レビューID」と「説明」を入力する。
  6. 「レビュー対象のファイル」を選択し、リストへ追加する。
  7. レビュアーの追加を行う。Authorも追加しておく。
  8. レビューセッションの作成者（Author）を選択する。基本的に、この一連の「セッションの設定」の手順を行っている人間になるはず。
  9. レビューのコメントの属性の種類に応じた項目を設定する。「Type（形式）」「Severity（重要度）」「Resolution（決定事項）」「Status（解決状態）」の4つ。
  10. 上記で設定した各項目のデフォルト値を設定する。
  11. 保存先の設定を行う。レビューをするたびに、ここで設定した保存先に対して、「${レビューID}-${作業者}.xml」というファイルがどんどん作成されていく仕組み。そして、このフォルダをSCMにチェックインして共有する。フォルダの作成先は対象のプロジェクト直下。
  12. レビューテーブルViewで表示するときのフィルターの設定を行う。
  13. レビューセッション用の設定（レビューIDの設定）はこれで終了。

レビューセッション用のJupiterの設定を作成する(二回目以降)

  1. レビューテーブルViewのToolbarButtonにあるDropDownに「プリファレンスの設定」「プロパティの設定」が存在するので、「プロパティの設定」を選択する。
  2. 以下のような画面が表示されるので、「新規作成」ボタンで新しくレビューIDを追加する。
…と書いたが、レビューが一件以上ないと「プロパティの設定」が表示されない、とか動作が不明な点が非常に多い。プロジェクト直下に配置される「.jupiter」ファイルを直接触るのが手っ取り早いかも！？

レビューコメントの追加

レビューコメントの編集は「レビューエディタ」Viewの「個別レビューモード」で作業する。
  1. レビューテーブルViewの左端のToolbarButtonの横のDropdownをClickすると「レビュー対象ファイル」の一覧が表示されるので、そこからファイルを選択する。
  2. 開いたファイルでコメントをつけたい行で右Clickし、「レビューを新規作成」を選択する。
  3. 「レビューエディタ」Viewの「個別レビューモード」タブにジャンプするので、コメントを入力してToolbarButtonの「保存」をClickする。
  4. ひととおりコメントをつけ終えたらJupiterのレビュー用フォルダをSCMにCommitする。
  5. 他の人のコメントを取得するときはJupiterのレビュー用フォルダをSCMからcheckoutし、「レビューテーブル」ViewのToolbarButtonにある「～を更新する」を選択する。

疑問

不明な動作が非常に多い。なんか危ない。
  • そもそも、「レビューID」の考え方とか、自分の解釈が正しいのか？
  • レビューが一件以上ないと「プロパティの設定」が表示されないような？つまり、レビューが一件も無いと新規にレビューIDを作成する手段が無い！？（.jupiterを直接いじれば良いのだが…）
  • レビューテーブルにアクティブなプロジェクト名、レビューIDが表示されているが、これはどうすれば切り替える事ができるのか？
  • レビューテーブルで開いているプロジェクトをCloseするとInternalErrorでEclipseごと終了してしまう。どーなってんだ。
  • Eclipse終了時に、ヤケに「Out of memory」が発生するようになった。たまに、プロセスが終了していないこともある。何が悪いのか？

Attachments (16)