Sandbox/Uruma の編集

[[Sandbox/Uruma]]

*コミッタメモ [#lcfb3b57]
**推奨Eclipseバージョン [#m686a053]
-3.3.1.1以降

**必須Eclipseプラグイン [#m36e6fef]
-[[subclipse:http://subclipse.tigris.org/]](またはSubversive)
-[[FindBugs:http://sourceforge.net/project/showfiles.php?group_id=96405&package_id=118233]]

**あると便利なプラグイン [#s91dc5e9]
-[[Eclipse Platform Extensions:http://sourceforge.net/projects/ttl/]]
-[[MylynConnectors(JIRA):http://www.eclipse.org/mylyn/downloads/]]
-[[Kijimuna:http://kijimuna.seasar.org/]]
-[[djUnit:http://works.dgic.co.jp/djwiki/]]
**リポジトリ構成について [#tc05c4cc]
trunk/uruma 配下が uruma 本体のプロジェクトです。Subclipse の場合は、trunk/uruma を右クリックしてチェックアウトしてください

なお、uruma プロジェクトは以下の2つのプロジェクトに依存しています。

-seasar2 (https://www.seasar.org/svn/s2container/trunk/seasar2)
-s2-tiger (https://www.seasar.org/svn/s2container/trunk/s2-tiger)

これは、uruma 本体の修正に伴い、s2container側に修正を加えることがあるためです。

**コミッタになったら [#rad1cef5]
pom.xml の developers セクションに差し支えない範囲で自分の情報を入力してコミットしてみてください。

**ビルドについて [#fd8f3afc]
uruma 本体は Maven2 を使ってビルドします。

Maven2 をインストールした状態で uruma のディレクトリをカレントディレクトリとしてコマンドプロンプトを開き、以下のコマンドでビルドが完了します。

mvn install

ビルド結果は uruma/target 配下に出力されます。また、RCP 環境用の Uruma プラグインが c:/eclipse/plugins 配下へコピーされるので注意してください。
**ソースコードについて [#v4fa1451]
-文字コードは UTF-8 です
--uruma プロジェクトのデフォルト設定をUTF-8に設定済みです
--新たにサンプルプロジェクトなどを作成する場合、プロジェクトのプロパティから[リソース]-[テキスト・ファイル・エンコード]で[その他]-[UTF-8]に設定してください

-コンパイラはJava5.0に固定しています
--Java6のみインストールしている方もJava5のインストールをお願いします

-ソースコードのフォーマット設定は uruma プロジェクトに組み込み済みです
--Eclipse 3.3 以降のデフォルト設定ならばソースコード保存時に自動的にフォーマットされます

**JIRAの利用について [#vba86a2c]
-機能追加/バグ修正を行うときには以下の手順に沿ってください
++新しくISSUEを追加する(このとき、Component と AffectVersion を必ず設定してください。Component に適当なものがない場合、自由に追加していただいて構いません)
++作業を開始するとき、StartProgress を実行する
++修正作業を行う
++作業が完了したらリポジトリにコミットする
++JIRA の該当 ISSUE を Resolved 状態にする(※このときCloseにしないこと)
++該当機能のリリースが完了したら ISSUE を Close 状態にする(これはリリース担当が行う)

**バージョンのポリシー [#y82eb74f]
すべてのサンプルは Uruma と同時に配布するため、対応する Uruma のバージョンに合わせてください。

たとえば、Uruma 0.4.0 に対応するサンプルであれば、新しく作成したサンプルであってもバージョンは 0.4.0 とします。

これはバージョンが同じであれば必ずサンプルが動作することを保証し、ユーザの混乱を防ぐためです。

**JavaDocを書くときの注意 [#hcf17628]
-public メソッドについては必ず記述する。
-文体は「ですます」調にすること
-クラスへの参照は {@link EventListener} のように記述のこと
-true、false や 引数名は <code></code> で括ること
-クラス、メソッドコメントの第1行は <br /> タグで終了すること
-半角英数字の前後は半角スペースを空けること。→見やすくするため
-Eclipseのフォーマッタは日本語の句読点を改行位置として認識しないため、<code></code> の前後などにも半角スペースを入れておくと良い。
-インターフェースの実装メソッドや、スーパークラスのメソッドをオーバーライドしている場合、特別な説明が不要な限りは Ctrl+Shift+J でEclipseが挿入するコメントを入れること。(以下の例参照)

/*
  * @see org.seasar.uruma.context.WindowContext#getWindowName()
  */
**ログ出力のポリシー [#x9c5fba9]
-メッセージは URMMessages_ja.properties に登録する
-メッセージコードは UrumaMessageCodes に登録する
-URMMessages_ja.properties と UrumaMessageCodes の整合性は UrumaMessageCodesTest クラスで自動チェックされるので、かならず JUnit テストを通してください
-メッセージ出力は UrumaLogger を利用する(UrumaMessageCodes は implement すると使いやすい)

タイムスタンプを変更しない