開発者ガイド

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

ソースコードの取得

GitHubからソースをクローンする。

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

ソースのビルド

ビルドにはApache Mavenを利用します。

mvn compile

テスト

テストはJUnitで行います。

mvn test

カバレッジはJacocoで確認することができます。

mvn test jacoco:report

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

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

mvn javadoc:javadoc

Mavenローカルリポジトリへのインストール

mvn install

IDE

Eclipse

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

Intellij

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

Continuous Integration

Continuous Integration(CI)はGitHub Actionsで行っています。

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

• https://coveralls.io/github/future-architect/uroborosql

Issue Management

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

• https://github.com/future-architect/uroborosql/issues
• https://github.com/future-architect/uroborosql/pulls