This article deals with the procedure of external reviews. It describes how the review process works so that modules can be included in the PIXERA installer. 

When does a module need to be reviewed?

This depends on if it is an externally or internally created module.

Internal

Modules only need to be reviewed when they are added to the installer or if major changes have been made to them. This is not necessary for small to medium changes and bug fixes if a module is already in the installer.

External

Modules only need to be reviewed when they are added to the installer or if major changes have been made to them. Every small to medium change is quickly checked during the commit process if the module is already in the installer.

Review internal created modules

See internal guide Control Repository 

Review external created modules

There are a few basic rules that must be followed for externally manufactured modules.

• 3rd party modules that are created externally must be of good enough quality to pass the review process (I am currently documenting what needs to be taken into account here).
• The maintenance of these modules will be left to the 3rd party even if already in the installer, and we reserve the right to remove the modules from the installer if they lead to problems that are not fixed in a certain time.
• The person currently responsible will carry out the review process or assign it if necessary.
• There must be an email address or URL to the author (or manufacturer company) in the properties of the module. The company logo or author logo must also be inserted here. Guideline for the resolution of this logo: 96 pixels in height, width may vary depending on aspect ratio.
• We reserve the right to reject modules without giving reasons.

The process:

Contact Support about your wish to add a module to the installer. This first contact may already contain the module.

Support will forward the request to the responsible person. Further contact can be made via the ticket system or by direct email to the responsible person if necessary. However, we prioritize the ticket system. If desired, the review process can be initiated directly with the responsible person.

In this step, further details about the module and the integration can be exchanged if necessary.

Information that must be included: Location in folder structure in which the module should be placed, or folders which should be newly created. 
The review process can run over several iterations of the module. If the module does not pass, the author is informed which criteria need to be improved, and this continues until the required quality is achieved.

If the module passes, it can be placed directly in the installer by the responsible person and will be included in the next release version.

The Review itself

The review itself is there to check:

• Test functionality of the module. (As far as possible without Hardware)
• The style guide is being followed. Module Style Guide 
• No debug log prints during production.
• Basic nil value check to ensure stability during runtime.
• Catch basic user errors. E.g. Invalid IP address.
• Short "How to use" description is available in the properties of the Module.
• Workflow check, is it self-explanatory or does it need improvements? Is the description enough?
• The functionality does not only work on the author's (developer's) system.

In some cases external hardware is required to test the functionality, organizing this can go beyond the scope of the review, therefore the functionality can/will not be tested for all modules.

Pixera 2.0.172 | 17. September 2024 | J.B.