開発者向け情報

ラングバプロジェクトはRubyからもっと便利にGroongaを使えるようにするため、開発に参加してくれる人を募集しています。ここでは、開発に必要となる情報を提供します。

リポジトリ

Rroonga、ActiveGroonga、ActiveGroonga Fabrication、racknga、ChupaText、文書検索ラングバのリポジトリはGitHub上にあります。 gitを利用しており、それぞれ以下のようにチェックアウトできます。

% git clone git://github.com/ranguba/rroonga.git

% git clone git://github.com/ranguba/activegroonga.git

% git clone git://github.com/ranguba/activegroonga-fabrication.git

% git clone git://github.com/ranguba/racknga.git

% git clone git://github.com/ranguba/chupa-text.git

% git clone git://github.com/ranguba/ranguba.git

Rroonga、ActiveGroonga、ActiveGroonga Fabrication、racknga、ChupaTextを利用したサンプルプログラムもリポジトリにあります。サンプルプログラムは以下のようにチェックアウトできます。

% git clone git://github.com/ranguba/examples.git

Rroongaをビルドするためにはextconf.rbとMakefileを使います。Rakefileは使いません。

ビルドしたいrubyでextconf.rbを実行してから、makeを実行します。

% ruby extconf.rb
% make

うまくいくとext/groonga/groonga.soができます。インストールせずにそのまま使う場合は以下のように$LOAD_PATHを設定してからrequireしてください。

% irb -I lib -I ext/groonga -r groonga

バグ報告はGroongaのメーリングリストまたはRedmineにお願いします。また、疑問点・意見・パッチなどもGroongaのメーリングリストにお願いします。

リポジトリにコミットがあるとそのコミットの差分がgroonga-commitメーリングリストに流れます。開発に興味がある場合はgroonga-commitメーリングリストを購読してください。

ドキュメントはソースコード中にYARDで記述しています。生成されたドキュメントはHTMLに変換され、リファレンスマニュアルとして公開されます。

いつかは英語と日本語を用意できればよいとは思いますが、とりあえず、現在は日本語のみ用意しています。日本語ドキュメントは直接ソースコード中に記述しています。YARDで多言語に対応したリファレンスマニュアルを作成する仕組みや、英語のドキュメント作成を手伝ってくれる人を募集しています。

また、Redmine上のWikiにもドキュメントがあります。 Wikiにはリファレンスマニュアルで扱わないような内容を中心に記述します。Tipsや関連情報など、必要そうな情報があったらメーリングリストで報告したり、Redmineに登録して直接編集してください。