Search jakarta

POIへの投稿・参加

はじめに

免責事項

ここに記述される全ての情報のうち法的インフォメーションを含むと認知されるものは、単なる情報にしか過ぎません。私たちは法律家ではありませんので、必要とあらば法的なプロの方に相談ください。

ライセンス

POIプロジェクトは、オープンソースであり、開発及び配布は、Apache Software Licenseの下に行われています。 他のライセンスと異なり、このライセンスは、フリーのオープンソース開発を許しています:しかし、ご自身のソースを提出することを要求しませんし、ご自身のソースに特定のライセンスがあっても使うことができます。もし、POIへの投稿・参加をお望みであれば(歓迎しますし、援助もします)、このライセンスの下で貴方のソースがリリースされる、という事に同意していなければなりません。

私は、Microsoft社と、仕様に関するNDA契約を結んでおりますが、POIに参加したいです

短く言ってしまえば、「近寄らないで下さい」。POIにおけるこれらのファイル形式の実装は、厳格に、公的に出されている情報を元に行われています。公的な情報とは、他のオープンソースプロジェクトからのソースや、機密保持契約を必要とせずにファイルフォー的の実装を許可する目的をもっていると明言している本、等を含みます。我々は、法的にも適切であるよう努めており、貴方にも同様のことを求める次第です。

もし貴方が、Microsoft社から排他的な種の契約の下にOLE2複合ドキュメントに関する情報を受け取ったことがあるなら、あるいは(多分違法ですが)それらの情報を、上述の種の契約に束縛されている人々から得たものであるならば、貴方はこのプロジェクトに参加することは不可能です(申し訳ないですが)。

ファイルフォーマットの中身に対する洞察を含むパッチを提出する場合、其の人は、自分が的確な人間であるかもしかしたら上述の契約に交わした可能性があるか否か、明確に言明するよう求められることがあるかもしれません。

参加したいと思っていますが、どこから手をつければいいものか、わかりません

  • このウェブサイトの残りのページをご覧いただき、POIとは何であって何をするものなのか、プロジェクトのビジョン、等々についての理解を深めてください。
  • POIを多少使ってください。そして、ドキュメントやサンプルの欠落個所を探してください。
  • メーリングリストに参加し、自己の知識を他の人々と共有してください。
  • CVSをゲットし、POIソースツリーからPOIをcheck out して下さい。
  • 投稿を始めるにあたり、ドキュメントが最も最適な場所である事でしょう。もしかすると、ドキュメントがXについてのHOWTOを単に提示しているだけでもっとより良いやり方があると考えれば、ドキュメントの修正を行ってください。
  • POIのビルドに慣れてください。多くのことが出来ます。ビルド方法やターゲットの指定等々。
  • ユニットテストを書いてみてください。POIを知る上で非常に良い方法です。テストされていないクラスを探してみてください、あるいはpublic/protected メソッドのレベルでテストされていないものを探してみてください。そして、そこから始めてください。
  • (HSSF) Excel 97 開発者キットを入手してください - 今は絶版になっていると思いますが、(汚いと思いますが)安い中古本がamazonあたりで$15USくらいで見つかると思います。Excelのファイル形式についての説明があります。
  • 貴方の投稿・修正のパッチ(以下をご覧下さい)を提出してください。
  • 新規機能を追加したければ、提案用にBug databaseをご覧下さい。

パッチの提出

CVS(HEAD)から最新のソースを入手してからパッチを作成してください。適切に変更・追加を行いましょう。そして、jakarta-poiディレクトリ(訳注:check out したディレクトリ)から、"cvs diff -u >mypatch.patch" とコマンドを打ちます。これによって、貴方が行った全ての変更点が巻き取られ、適切な形式のパッチファイルを生成します。次に、ファイルを追加した場合は、相対パスのアーカイブ形式(jakarta-poiディレクトリからの相対)で、アーカイブを作成してください(tar.bz2が一番サイズが小さくなるのでお奨めでしょう)。

注:もし、WinCVSをお使いであれば、[Admin] -> [Command Line] メニューの順番で移動し、ターゲットとなるディレクトリやファイルを選択した状態で、[Enter a cvs line command] ([Commandline Settings] タブ) の個所で"cvs diff -u" と打ちます。そうすれば、unified diff 形式のパッチが出来上がります(訳注:この部分は、訳者が原文も書きましたが、WinCVSのパスをきちんと通せば、コマンドプロンプトで"cvs diff -u *.java > hoge.patch"をやってみても良いです。其の場合、">"を使うとファイルを作成することが出来ます)。 言い換えれば、[Alt+A]+[Alt+C]+[Alt+C] で、"cvs diff -u" と(フィールド内で)打ちます。次のステップで両ファイルを添付します。

Bug Databaseを通じてパッチを提出して下さい。 新しい「バグ」を作成し、その題名に[PATCH]という接頭辞とともに簡単な説明を入れてください。パッチの説明と特別な指示を添え、提出(submit)/保存(save)を行います。 次に、その(先ほど作成したバグ)に戻り、貴方がおつくりになったパッチファイルを添付として作成します。ファイルの目的だけに限らず、そのファイルの形式(ZIPなのかtgzなのかbz2なのか何なのか)もあわせて記述するようにして下さい。

貴方のパッチの、自分が変更・作成したファイル夫々に@authorタグが入れてあるかどうかを確認してください。貴方の変更点が文書化されそれらがサンプル等にも反映されたかどうか確認してください。新規の如何なる追加も、ユニットテストが必要となります。最後に、適切なJavadocを書いたかどうかを確認ください(コーディング基準をご覧下さい)。低レベルのパッチであればもしかすると拒否されるかもしれませんし、仕様にあわせるようお願いすることがあるかもしれません。

by Nicola Ken Barozzi, Marc Johnson, Andrew C. Oliver, Tetsuya Kitahata
Original English Page would be found from HERE     --/Apache News
Terra-International, Inc. -- テラ・インターナショナル