PEAR の初期においては、新しいパッケージの投稿は、PEAR 開発者メーリングリストにメールを出すという略式なものでした。 時が経つにつれ、新たなパッケージの投稿の数も劇的に増加し、すべての投稿を把握することが 難しくなって来ました。
そこで、問題を解決するために、WEB ベースの投稿管理システムが構築されました。 そのシステムは、PEPr と呼ばれています。 "PEAR Proposal system" の略称で、スパイス(の胡椒)と同じように発音されます。
この章では、まず、PEPr を用いて投稿を行う際の要求事項とワークフローについて述べます。 ついで、実際に投稿する方法についての情報を提供します。 最後に、投稿が採択された後に行うべき事柄について説明します。
この章を読めば、すぐにパッケージを投稿することができることでしょう。
投稿する 前 に行っておく必要のある事項は、以下の通りです。
パッケージの名称を決める
各パッケージは、当然、それぞれ異なる名前である必要があります。 適切なパッケージ名はどうのようなものか"感じる"ために、 既存パッケージ一覧を 参照してください。
パッケージ名の選択は、ある種の反復プロセスで、 投稿採択プロセス中に名前を変更することになるかも知れません。
パッケージの所属カテゴリを決める
パッケージの名称がそれぞれ異なるということに関連していますが、 パッケージはカテゴリに所属する必要があります。 カテゴリは、パッケージブラウザに リストされています。
パッケージの説明を書く
投稿するには、パッケージの説明が必要です。 この説明には、パッケージについて細部まで細かく記述する必要は無いですが、 少なくとも、基本的なコンセプトと機能の一覧については記しておくべきです。 パッケージが受け入れられたら、1行にまとめた概要と、全文の説明を 書くこととなります。
パッケージのライセンスを選択する
各パッケージは、認定済みのオープンソースライセンスの基で利用許諾される 必要があります。オープンソースライセンスについて良く知らないのならば、 PHP ライセンスを選ぶと良いでしょう。 PEAR グループは、この件に関連して、 ライセンスについてのアナウンスメント (License Announcement) を発表しています。
サンプルと文書を書く
サンプルや文書なしでは、PEAR 開発者がパッケージを評価することができませんし、 ユーザがパッケージを利用することもできません。
依存性を示す
他の PEAR パッケージや特定の OS や外部アプリケーションなど、 パッケージの実行に必要な外部要素を列挙し、依存性のリストを作成します。
例 11-1依存性リストの例 パッケージは、Linux でのみ動作し、DB パッケージ、および バージョン 1.8.4 以降の Log パッケージを必要とし、 PHP 4.3.0 以降でのみ動く場合、依存性リストは以下のようになります。
|