「プラグインガイドライン」の版間の差分

2021年1月11日 (月) 10:58時点における最新版

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

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

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

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

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

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

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

開発者/スポンサー以外の誰かがそれをテストしましたか？
誰がどのように使用しますか？

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

@@ 1行目: / 1行目: @@
-In the [[IDempiere_workshop_2019]] we had the idea to implement guidelines for plugins.
+[https://wiki.idempiere.org/en/IDempiere_workshop_2019 World Workshop2019]において、私たちはプラグインの実装のガイドラインについてアイディアを出し合いました。
-This is part of a list of all possible contributions, you can check those in [[Contributing to iDempiere]].
+これは[[IDempiereコミュニティーへの貢献]]方法の１つです。
-These guidelines allow us to evaluate and judge plugins. It will also improve documentation. These guidelines are not static and will be updated with time. If you have any suggestions please contact us in the forums.
+これらのガイドラインにより、プラグインを評価および判断できます。 また、ドキュメントも改善されます。 これらのガイドラインは静的ではなく、時間とともに更新されます。 ご提案がございましたら、フォーラムでお問い合わせください。
-As a first step, every community plugin should have the following:
+最初のステップとして、すべてのコミュニティプラグインには次のものが必要です。:
-#  Documentation
+#  ドキュメント
-## How to Install - check the list below.
+## インストール方法 - 下記のリストを確認して下さい。
-## What does it do? What is the purpose of the plugin?
+## プラグインは何をするためのものか？ プラグインの目的は何ですか？
-## Include screenshots and videos - if possible. The idea is to show the community what they will get when installing the plugin.
+## 可能であれば、スクリーンショットとビデオを含めます。 アイデアは、プラグインをインストールしたときに何が得られるかをコミュニティに示すことです。
-## Technical Documentation - It there are special aspects to consider when trying to extend or contribute to the plugin, please document those technical aspects.
+## 技術文書-プラグインを拡張または提供しようとするときに考慮すべき特別な側面があります。それらの技術的側面を文書化してください。
-### Access to the source code (no broken links) - '''mandatory'''.  Please note we want to support real open source, not those repositories that are update publicly every year, outdated against a private repository that gets frequent updates and is not visible for community.
+### ソースコードへのアクセス（壊れたリンクなし）-'' '必須' ''。 毎年公開されて更新され、頻繁に更新されてコミュニティに表示されないプライベートリポジトリに対して古くなっているリポジトリではなく、実際のオープンソースをサポートしたいことに注意してください。
-### Access to the source code of the documentation (e.g. not only a pdf).
+### ドキュメントのソースコードへのアクセス（PDFだけでなく）。
-### List of plugin dependencies.
+### プラグインの依存関係のリスト。
-### List of similar or related solutions.
+### 類似または関連するソリューションのリスト。
-# It must be easy to install in existing iDempiere instances (plugins that require a modified core to install must be considered a fork or a distro, not a real plugin) - ''via the OSGi or Felix consoles with no extra steps is preferred. If there are more steps needed or additional configurations that cannot be done through 2packs, they should be well justified and documented''.
+# 既存のiDempiereインスタンスに簡単にインストールできる必要があります（インストールするために変更されたコアが必要なプラグインは、実際のプラグインではなく、フォークまたはディストリビューションと見なす必要があります）-''追加の手順なしでOSGiまたはFelixコンソールを介してインストールすることをお勧めします。 さらに必要な手順や2パックでは実行できない追加の構成がある場合は、十分に正当化して文書化する必要があります」.
-## Includes 2pack
+## 2packのファイルを含めて下さい。
-## Just install in the OSGi or Felix console and start it.
+## OSGiまたはFelixコンソールにインストールして起動するだけにして下さい。
-## The Binaries are available
+## バイナリで利用可能な状態にします。
-## One-click start
+## ワンクリックでスタートします。
-### If Chuck prefers to separate the plugin into several files we allow him to do up to four-click-installation if it is very well documented.
+### Chuckがプラグインをいくつかのファイルに分割することを好む場合、それが非常によく文書化されていれば、最大4回のクリックインストールを実行できます。
-# Plugin status
+# プラグインのステータス
-## Is the plugin compatible with the latest stable version of iDempiere?
+## プラグインはiDempiereの最新の安定バージョンと互換性がありますか？
-## Date and version of the last review.
+## 最後のレビューの日付とバージョン
-For best practices when developing community plugins you can follow the tutorials here [[:Category:Plug-In_Development|Plug-In Development]], in there it is well explained how to extend iDempiere without affecting the core.
+コミュニティプラグインを開発する際のベストプラクティスについては、こちらのチュートリアル[[Plug-In_Development]]に従ってください。ここでは、コアに影響を与えずにiDempiereを拡張する方法が十分に説明されています。
-Additionally, the community could asses the plugin quality with the following information:
+さらに、コミュニティは次の情報を使用してプラグインの品質を評価できます:
-* Is there someone who tested it other than the developer/sponsor?
+* 開発者/スポンサー以外の誰かがそれをテストしましたか？
-* Who uses it and how?
+* 誰がどのように使用しますか？
-* Code quality peer review / make sure that the plugin follows best practices (f.e. closing prepare statements to avoid memory leaks).
+* コード品質のピアレビュー/プラグインがベストプラクティスに従っていることを確認します（メモリリークを回避するためにprepareステートメントを閉じるなど）。
-** Someone (not the developer) has to review the code
+** 誰か（実際に開発した人以外）がコードを確認する必要があります。
-** Don't use hardcoded IDs
+** ハードコードされたIDを使用しないでください
-** Close cursors in "finally" blocks
+** "finally"句でカーソルを閉じて下さい。
-** Security peer review - does the plugin open security breaches?
+** セキュリティピアレビュー-プラグインはセキュリティ違反していませんか？
 [[Category:Development‏‎]]