What are the requirements in creating an osDXP Module?
Created On
byKarim Marucchi
What are the requirements in creating an osDXP Module?
As of the date of this FAQ, the osDXP Project is meeting to ratify the 1.0 Draft of osDXP Modules guidelines, as seen below. For an up-to the date version of current guidelines, the project is maintaining living documents on GitHub that will be helpful when determining if each module will be a fit.
osDXP Modules (Plugin) guidelines
- Adhere to all WordPress Plugin Directory Guidelines & GPL Compliant Codebase
- Plugins should register only one settings page, available as a subpage of Module Settings
- PHP 7.4 min. Version required
- Detailed docblocks need to be present throughout your codebase
- Valid codebase
- Plugins must validate against an established ruleset for PHP and meet ES6 standards for JavaScript, passing linting tests against these rules.
- The preferred PHPCS ruleset is a custom one made up of PSR12 and some necessary checks for WordPress security, sanitization, and prevention of deprecated code.
- Javascript should validate against ES6, at a minimum.
- No SaaS-ification of Client Data (because enterprises need to be in control of their data)
- No Customer Data is saved on Vendors System (SaaS)
- Clear data privacy standards
- Accessibility declaration
- Object Oriented/Class Based PHP
- Follow osDXP UX Standards
- No "AdWare" (promotional popups, admin notices, or other text taking up screen space)
-
- Articles coming soon