null+****@clear*****
null+****@clear*****
2010年 9月 16日 (木) 14:42:45 JST
Tetsuro IKEDA 2010-09-16 05:42:45 +0000 (Thu, 16 Sep 2010)
New Revision: 20a79bfabe225a38009b48037519ea58f7321b55
Log:
added more description about development process.
Modified files:
doc/ja/source/developer.rst
Modified: doc/ja/source/developer.rst (+9 -10)
===================================================================
--- doc/ja/source/developer.rst 2010-09-15 15:57:52 +0000 (26fd118)
+++ doc/ja/source/developer.rst 2010-09-16 05:42:45 +0000 (adc762b)
@@ -42,16 +42,14 @@ http://github.com/mroonga/mroonga
1. チケットの新規作成と内容の記述
2. 開発会議での検討(ロードマップへの反映)
3. チケットの割り当て(担当者作業開始)
-4. 機能実装あるいはバグの修正作業
-5. テストコードの追加と実行
-6. 実装/テスト内容に対するレビュー
-7. ドキュメントの追加/変更
+4. 機能実装あるいはバグの修正作業、必要に応じてレポジトリへのpush
+5. テストコードの追加と実行、レポジトリへのpush
+6. 実装/テスト内容に対するレビュー(必要に応じて4へ戻る)
+7. ドキュメントの追加/変更、 レポジトリへのpush
8. チケットの完了
機能追加や仕様変更などについても積極的にアイデアを募集します。まずはチケットを新規作成して内容を記述して下さい。
-レポジトリへのcommitおよびpushのタイミングは開発者の方にお任せしますが、チケットとの対応が後で分かるようにしておいて下さい。
-
テストコードの追加と実行については後述しますのでそちらを参照して下さい。
基本的にチケットを担当されている方が設計、実装、テスト、ドキュメントまで一通りお願いしたいと考えています。
@@ -149,10 +147,11 @@ groongaストレージエンジンではドキュメント作成にsphinxを使
ドキュメントのソースファイルは"doc/ja/source"ディレクトリにある拡張子が.rstのファイルです。
-加筆修正を行ったら"make html"等でビルドして下さい。
+加筆修正を行ったら"make html"等でビルドして構文エラーが起きないことを確認して下さい。
+
+ドキュメントの実際の公開場所は http://mroonga.github.com で、これはgithubのサイト機能を使用しているため http://github.com/mroonga/mroonga.github.com レポジトリに最新のHTML出力ファイルをpushすることで更新が行われる仕組みとなっていますが、mroonga.github.comレポジトリへのpushは現リリースバージョンとの整合性などを確認した上で別のタイミングでpushします。
-ドキュメントの公開場所は http://mroonga.github.com です。
+従って、各チケットに対するドキュメントのpushはmroongaレポジトリに対するpushのみで構いません。
-githubのサイト機能を使用しているため http://github.com/mroonga/mroonga.github.com レポジトリに最新のHTML出力ファイルをpushすることで更新が行われます。
+またsphinxの出力するディレクトリ名がgithubで使用できない問題を回避するため、"doc/ja/source"ディレクトリにてsphinx2github.shスクリプトを用意しています。mroonga.github.comにcommitする場合にはこのスクリプトを実行してsphinxの生成したファイルを修正して置きましょう。
-sphinxの出力するディレクトリ名がgithubで使用できない問題を回避するため、"doc/ja/source"ディレクトリにてsphinx2github.shスクリプトを用意しています。このスクリプトを実行した上でcommitおよびpushして下さい。