Plugin Guidelines - Revision history

Diego.ruiz at 12:58, 24 August 2023

2023-08-24T12:58:22Z

Schnbeck at 19:57, 1 July 2022

2022-07-01T19:57:30Z

Hideaki Hagiwara: Added Japanese translation

2021-01-11T08:34:02Z

Added Japanese translation

Diego.ruiz at 13:15, 18 January 2020

2020-01-18T13:15:07Z

Diego.ruiz at 13:10, 18 January 2020

2020-01-18T13:10:45Z

CarlosRuiz: clarifications about installation

2020-01-18T11:57:43Z

clarifications about installation

CarlosRuiz: more clarification about open sourceness

2020-01-18T11:43:18Z

more clarification about open sourceness

Diego.ruiz at 17:30, 17 January 2020

2020-01-17T17:30:10Z

Diego.ruiz at 17:29, 17 January 2020

2020-01-17T17:29:11Z

Diego.ruiz at 14:44, 27 December 2019

2019-12-27T14:44:33Z

@@ Line 41: / Line 41: @@
 [[Category:Developer documentation‏‎]]
 [[Category:Updated2022]]
 [[Category:Explanation]]
 [[ja:プラグインガイドライン]]

@@ Line 40: / Line 40: @@
 [[Category:Development‏‎]]
 [[Category:Developer documentation‏‎]]
+[[Category:Updated2022]]
 [[ja:プラグインガイドライン]]

← Older revision		Revision as of 08:34, 11 January 2021
Line 40:		Line 40:
	[[Category:Development‏‎]]		[[Category:Development‏‎]]
	[[Category:Developer documentation‏‎]]		[[Category:Developer documentation‏‎]]
		+
		+	[[ja:プラグインガイドライン]]

@@ Line 25: / Line 25: @@
 ## Is the plugin compatible with the latest stable version of iDempiere?
 ## Date and version of the last review.
 Additionally, the community could asses the plugin quality with the following information:

@@ Line 22: / Line 22: @@
 ## 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.
+# Plugin status
+## Is the plugin compatible with the latest stable version of iDempiere?
-* Plugin status
+## Date and version of the last review.
 Additionally, the community could asses the plugin quality with the following information:

@@ Line 16: / Line 16: @@
 ### List of plugin dependencies.
 ### List of similar or related solutions.
-# It must be easy to install - ''via the OSGi console 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''.
+# 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''.
 ## Includes 2pack
-## Just install in the Felix console and start it.
+## Just install in the OSGi or Felix console and start it.
 ## The Binaries are available
 ## One-click start

@@ Line 12: / Line 12: @@
 ## 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'''
+### 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).
 ### List of plugin dependencies.

@@ Line 7: / Line 7: @@
 As a first step, every community plugin should have the following:
-* Documentation
+#  Documentation
-** How to Install - check the list below.
+## How to Install - check the list below.
-** What does it do? What is the purpose of the plugin?
+## 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.
+## 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.
+## 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'''
+### Access to the source code (no broken links) - '''mandatory'''
-*** Access to the source code of the documentation (e.g. not only a pdf).
+### Access to the source code of the documentation (e.g. not only a pdf).
-*** List of plugin dependencies.
+### List of plugin dependencies.
-*** List of similar or related solutions.
+### List of similar or related solutions.
 * It must be easy to install - ''via the OSGi console 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''.

@@ Line 36: / Line 36: @@
 ** Someone (not the developer) has to review the code
 ** Don't use hardcoded IDs
-** Close cursors in "finallly" blocks
+** Close cursors in "finally" blocks
 ** Security peer review - does the plugin open security breaches?