# 開発者ガイド

uroboroSQLを開発する人向けのガイドです

# ソースコードの取得

GitHub (opens new window)からソースをクローンする。

git clone https://github.com/future-architect/uroborosql.git

ビルドにはApache Maven (opens new window)を利用します。

mvn compile

テストはJUnit (opens new window)で行います。

mvn test

カバレッジはJacoco (opens new window)で確認することができます。

mvn test jacoco:report

target/site/jacoco フォルダにjacocoカバレッジレポートが出力されます。

開発を行う際は、Jadocコメントが正しく記載されているようにしてください。
javadocプラグインでjavadocを生成し、エラーが出力されないことを確認してください。

mvn javadoc:javadoc

mvn install

クローンしたフォルダをEclipseの既存Mavenプロジェクトとしてインポートしてください。
MavenのinitializeフェーズでEclipseプロジェクトの文字コードをUTF-8にする設定が入っているので、インポートが完了すれば開発が始められる状態になります。

Import Project でクローンしたフォルダを指定してください。
Import project from external model でMavenを選択してください。
プロジェクトが読み込まれると開発が始められる状態になります。

Continuous Integration(CI)はTravis CI (opens new window)で行っています。

CIの状況確認は以下で行います。

また、CIと合わせてカバレッジレポートをCoveralls (opens new window)で公開しています。

IssueとPullRequestはGithubの機能を利用しています。
コメントは英語で記載をお願いします。（Google翻訳がお勧めです）