Difference between revisions of "JED Entries Installation and Functionality Checklist"

From Joomla! Documentation
m (S:MyLanguage added)
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{RightTOC}}This article is designed to help Extension Developers (who want to be listed  at JED), JED Editors (consistence for extensions approval) and general users (on reporting JED entries).
+
<noinclude><languages /></noinclude>
 +
{{RightTOC}}<translate><!--T:1-->
 +
This article is designed to help Extension Developers (who want to be listed  at JED), JED Editors (consistence for extensions approval) and general users (on reporting JED entries).</translate>
  
−
To be approved and listed in JED an entry must be verified in a 4 steps checklist process
+
<translate><!--T:2-->
−
* '''You are now in fourth step '''
+
To be approved and listed in JED an entry must be verified in a 4 steps checklist process:</translate>
 +
<translate><!--T:3-->
 +
* Step A - [[S:MyLanguage/JED_Entries_Submission_Checklist|Submission Checklist]]</translate>
 +
<translate><!--T:4-->
 +
* Step B - [[S:MyLanguage/JED_Entries_Trademark_Checklist|Trademark Checklist]]</translate>
 +
<translate><!--T:5-->
 +
* Step C - [[S:MyLanguage/JED_Entries_License_Checklist|License Checklist]]</translate>
 +
<translate><!--T:6-->
 +
* '''Step D - [[S:MyLanguage/JED_Entries_Installation_and_Functionality_Checklist|Installation and Functionality Checklist]]'''</translate>
  
−
==List D1 -  Installation ==
+
<translate>==Step D: Installation and Functionality Checklist== <!--T:7--></translate>
 +
 
 +
<translate>===List D1 -  Installation=== <!--T:8--></translate>
 +
<translate><!--T:9-->
 +
The following criteria is considered while approving a listing based on the listing installation method.</translate>
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
−
|+ Could this be installed with Joomla?
+
|+ <translate><!--T:10-->
−
! Item !! What? !! Publishable?
+
Could this be installed with Joomla?</translate>
 +
! <translate><!--T:11-->
 +
Item</translate> !! <translate><!--T:12-->
 +
What?</translate> !! <translate><!--T:13-->
 +
Publishable?</translate>
 
|-
 
|-
−
| 1 || Install with Joomla installer? || YES!
+
| 1 || <translate><!--T:14-->
−
* Some specific extensions are installed by extension special installer
+
Extension can be installed with the Joomla installer</translate>|| <translate><!--T:15-->
 +
Yes! Some specific extensions are installed by an extensions-specific installer.</translate>
 
|-
 
|-
−
| 2 || Extensions needs a hack to install? || No
+
| 2 || <translate><!--T:16-->
 +
Extension needs a hack to install</translate> || <translate><!--T:17-->
 +
No!</translate>
 
|-
 
|-
−
| 3 || Extensions needs manual copy file to install? || No
+
| 3 || <translate><!--T:18-->
−
* Exceptions available for Payment systems
+
Extension needs a manual copy file to install</translate> || <translate><!--T:19-->
 +
No, but exceptions are made for payment systems.</translate>
 
|-
 
|-
−
| 4 || Extensions hacks Joomla files? || No
+
| 4 || <translate><!--T:20-->
−
* Please contribute with code to Joomla Core
+
Extension hacks Joomla files</translate> || <translate><!--T:21-->
 +
No!</translate>
 
|-
 
|-
−
| 5 || Extensions changes other extension files? || Only if the changes are reverted upon uninstall
+
| 5 || <translate><!--T:22-->
−
* Extension hacks are not allowed!
+
Extension changes other extension files</translate> || <translate><!--T:23-->
 +
Only if the changes are reverted if the extension is uninstalled. Extension hacks are not allowed.</translate>
 
|}
 
|}
  
−
 
+
<translate>===List D2 - Basic Functionality=== <!--T:24--></translate>
−
==List D2 - Basic Functionality ==
+
<translate><!--T:25-->
−
This is not intended as a full functionality test.
+
The following criteria is considered while approving a listing based on the basic functionality of an extension after it is installed.</translate>
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
−
|+ Does it works in a Joomla site?
+
|+ <translate><!--T:26-->
−
! Item !! What? !! Publishable?
+
Does it work in a Joomla site?</translate>
 +
! <translate><!--T:27-->
 +
Item</translate> !! <translate><!--T:28-->
 +
What?</translate> !! <translate><!--T:29-->
 +
Publishable?</translate>
 
|-
 
|-
−
| 1 || Component configuration on Admin Menu works? || YES!
+
| 1 || <translate><!--T:30-->
 +
Component configuration works in the administrator menu</translate> || <translate><!--T:31-->
 +
Yes!</translate>
 
|-
 
|-
−
| 2 || Module can be published? || YES
+
| 2 || <translate><!--T:32-->
 +
Module can be published/unpublished</translate> || <translate><!--T:33-->
 +
Yes!</translate>
 
|-
 
|-
−
| 3 || Plugin can be activated and site/article its working? || YES
+
| 3 || <translate><!--T:34-->
−
* Legacy plugin requires a note on Joomla! version compatibility
+
Plugin can be activated/deactivated in the site</translate> || <translate><!--T:35-->
 +
Yes! Legacy plugins require a note on Joomla! version compatibility.</translate>
 
|-
 
|-
−
| 4 || In the component, is it possible to add a new item/category/file? || YES
+
| 4 || <translate><!--T:36-->
 +
It's possible to add a new item/category/file in the component</translate> || <translate><!--T:37-->
 +
Yes!</translate>
 
|-
 
|-
−
| 5 || Intended for public sites? || No
+
| 5 || <translate><!--T:38-->
−
* Latest version cannot be a "test only" version
+
Extension is intended for public sites</translate> || <translate><!--T:39-->
 +
No! The latest version cannot be a "test only" version.</translate>
 
|}
 
|}
  
−
==List D3 -  Security ==
+
<translate>===List D3 -  Security=== <!--T:40--></translate>
−
This is not intended for a full security test.
+
<translate><!--T:41-->
 +
The following criteria is considered while approving a listing based on the security of an extension after it is installed.</translate>
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
−
|+ Does it presents a security risk?
+
|+ <translate><!--T:42-->
−
! Item !! What? !! Publishable?
+
Does it presents a security risk?</translate>
 +
! <translate><!--T:43-->
 +
Item</translate> !! <translate><!--T:44-->
 +
What?</translate> !! <translate><!--T:45-->
 +
Publishable?</translate>
 
|-
 
|-
−
| 1 || Listed at Vulnerable Extensions List || NO!
+
| 1 || <translate><!--T:46-->
−
* [http://vel.joomla.org/ List VEL]
+
Extension is listed on the vulnerable extensions list</translate> || <translate><!--T:47-->
 +
No! [http://vel.joomla.org/ VEL List]</translate>
 
|-
 
|-
−
| 2 || Permissions: requires a 777 permission to install or run || NO!
+
| 2 || <translate><!--T:48-->
 +
Extension requires a 777 permission to install or run</translate> || <translate><!--T:49-->
 +
No!</translate>
 
|-
 
|-
−
| 3 || Sanitized: statement for ''Restricted access'' at top of the PHP files? || YES!
+
| 3 || <translate><!--T:50-->
−
* [[Restricted_access|Restricted access]]
+
Sanitized: statement for Restricted Access at top of the PHP files</translate> || <translate><!--T:51-->
 +
Yes!</translate>
 +
<translate><!--T:52-->
 +
[[S:MyLanguage/Restricted_access|Restricted access]]</translate>
 
|}
 
|}
 +
<translate><!--T:53-->
 
See  
 
See  
−
* FAQ: [[Security_and_Performance_FAQs#Joomla.21_Extensions|Extensions Security]]
+
* FAQ: [[S:MyLanguage/Security_and_Performance_FAQs#Joomla.21_Extensions|Extensions Security]]
−
* Tutorial: [[Securing Joomla extensions]]
+
* Tutorial: [[S:MyLanguage/Securing Joomla extensions|Securing Joomla extensions]]</translate>
−
 
 
  
−
==List D4 -  Uninstall ==
+
<translate>===List D4 -  Uninstall=== <!--T:54--></translate>
 +
<translate><!--T:55-->
 +
The following criteria is considered while approving a listing based on the way the extension is uninstalled from Joomla.</translate>
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
−
|+ Does it breaks a Joomla site?
+
|+ <translate><!--T:56-->
−
! Item !! What? !! Publishable?
+
Does it breaks a Joomla site?</translate>
 +
! <translate><!--T:57-->
 +
Item</translate> !! <translate><!--T:58-->
 +
What?</translate> !! <translate><!--T:59-->
 +
Publishable?</translate>
 
|-
 
|-
−
| 1 || After uninstall, Site or Admin returns errors? || NO!
+
| 1 || <translate><!--T:60-->
−
* [[Uninstalling_an_extension|Uninstalling an extension]]
+
After the uninstall, the site or the administration area returns errors</translate> || <translate><!--T:61-->
 +
No! [[S:MyLanguage/Uninstalling_an_extension|Uninstalling an extension]]</translate>
 
|}
 
|}
  
 +
<translate><!--T:62-->
 +
'''Everything OK?''' Publish extension!</translate>
  
−
'''Everything OK?''' Publish extension!
+
<translate>==More information== <!--T:63--></translate>
−
 
+
<translate><!--T:64-->
−
 
+
*See: [http://extensions.joomla.org/support/knowledgebase/item/jed-entries-checklists Entries Checklists on the JED website]</translate>
−
==TOC: JED Submissions Checklists ==
 
−
Table of Contents
 
−
* Step A - [[JED_Entries_Submission_Checklist|Submission Checklist]]
 
−
* Step B - [[JED_Entries_Trademark_Checklist|Trademark Checklist]]
 
−
* Step C - [[JED_Entries_License_Checklist|License Checklist]]
 
−
* Step D - [[JED_Entries_Installation_and_Functionality_Checklist|Installation and Functionality Checklist]]
 
−
 
 
  
−
[[Category:JED]] [[Category:Licence]]
+
<noinclude>
 +
<translate>
 +
<!--T:65-->
 +
[[Category:JED]]
 +
[[Category:Licence]]
 +
</translate>
 +
</noinclude>

Revision as of 15:03, 20 August 2015

This article is designed to help Extension Developers (who want to be listed at JED), JED Editors (consistence for extensions approval) and general users (on reporting JED entries).

To be approved and listed in JED an entry must be verified in a 4 steps checklist process:

Step D: Installation and Functionality Checklist[edit]

List D1 - Installation[edit]

The following criteria is considered while approving a listing based on the listing installation method.

Could this be installed with Joomla?
Item What? Publishable?
1 Extension can be installed with the Joomla installer Yes! Some specific extensions are installed by an extensions-specific installer.
2 Extension needs a hack to install No!
3 Extension needs a manual copy file to install No, but exceptions are made for payment systems.
4 Extension hacks Joomla files No!
5 Extension changes other extension files Only if the changes are reverted if the extension is uninstalled. Extension hacks are not allowed.

List D2 - Basic Functionality[edit]

The following criteria is considered while approving a listing based on the basic functionality of an extension after it is installed.

Does it work in a Joomla site?
Item What? Publishable?
1 Component configuration works in the administrator menu Yes!
2 Module can be published/unpublished Yes!
3 Plugin can be activated/deactivated in the site Yes! Legacy plugins require a note on Joomla! version compatibility.
4 It's possible to add a new item/category/file in the component Yes!
5 Extension is intended for public sites No! The latest version cannot be a "test only" version.

List D3 - Security[edit]

The following criteria is considered while approving a listing based on the security of an extension after it is installed.

Does it presents a security risk?
Item What? Publishable?
1 Extension is listed on the vulnerable extensions list No! VEL List
2 Extension requires a 777 permission to install or run No!
3 Sanitized: statement for Restricted Access at top of the PHP files Yes!

Restricted access

See

List D4 - Uninstall[edit]

The following criteria is considered while approving a listing based on the way the extension is uninstalled from Joomla.

Does it breaks a Joomla site?
Item What? Publishable?
1 After the uninstall, the site or the administration area returns errors No! Uninstalling an extension

Everything OK? Publish extension!

More information[edit]

Retrieved from "https://docs.joomla.org/index.php?title=JED_Entries_Installation_and_Functionality_Checklist&oldid=218228"