プラグインガイドライン

提供: iDempiere ja
移動先:案内検索

World Workshop2019において、私たちはプラグインの実装のガイドラインについてアイディアを出し合いました。

これはIDempiereコミュニティーへの貢献方法の1つです。

これらのガイドラインにより、プラグインを評価および判断できます。 また、ドキュメントも改善されます。 これらのガイドラインは静的ではなく、時間とともに更新されます。 ご提案がございましたら、フォーラムでお問い合わせください。

最初のステップとして、すべてのコミュニティプラグインには次のものが必要です。:

  1. ドキュメント
    1. インストール方法 - 下記のリストを確認して下さい。
    2. プラグインは何をするためのものか? プラグインの目的は何ですか?
    3. 可能であれば、スクリーンショットとビデオを含めます。 アイデアは、プラグインをインストールしたときに何が得られるかをコミュニティに示すことです。
    4. 技術文書-プラグインを拡張または提供しようとするときに考慮すべき特別な側面があります。それらの技術的側面を文書化してください。
      1. ソースコードへのアクセス(壊れたリンクなし)- '必須' 。 毎年公開されて更新され、頻繁に更新されてコミュニティに表示されないプライベートリポジトリに対して古くなっているリポジトリではなく、実際のオープンソースをサポートしたいことに注意してください。
      2. ドキュメントのソースコードへのアクセス(PDFだけでなく)。
      3. プラグインの依存関係のリスト。
      4. 類似または関連するソリューションのリスト。
  2. 既存のiDempiereインスタンスに簡単にインストールできる必要があります(インストールするために変更されたコアが必要なプラグインは、実際のプラグインではなく、フォークまたはディストリビューションと見なす必要があります)-追加の手順なしでOSGiまたはFelixコンソールを介してインストールすることをお勧めします。 さらに必要な手順や2パックでは実行できない追加の構成がある場合は、十分に正当化して文書化する必要があります」.
    1. 2packのファイルを含めて下さい。
    2. OSGiまたはFelixコンソールにインストールして起動するだけにして下さい。
    3. バイナリで利用可能な状態にします。
    4. ワンクリックでスタートします。
      1. Chuckがプラグインをいくつかのファイルに分割することを好む場合、それが非常によく文書化されていれば、最大4回のクリックインストールを実行できます。
  3. プラグインのステータス
    1. プラグインはiDempiereの最新の安定バージョンと互換性がありますか?
    2. 最後のレビューの日付とバージョン

コミュニティプラグインを開発する際のベストプラクティスについては、こちらのチュートリアルPlug-In_Developmentに従ってください。ここでは、コアに影響を与えずにiDempiereを拡張する方法が十分に説明されています。

さらに、コミュニティは次の情報を使用してプラグインの品質を評価できます:

  • 開発者/スポンサー以外の誰かがそれをテストしましたか?
  • 誰がどのように使用しますか?
  • コード品質のピアレビュー/プラグインがベストプラクティスに従っていることを確認します(メモリリークを回避するためにprepareステートメントを閉じるなど)。
    • 誰か(実際に開発した人以外)がコードを確認する必要があります。
    • ハードコードされたIDを使用しないでください
    • "finally"句でカーソルを閉じて下さい。
    • セキュリティピアレビュー-プラグインはセキュリティ違反していませんか?