Plugins Approved by Sylius¶
As the Sylius eCommerce framework is an open source project it has an awesome community of users and developers. Therefore our ecosystem flourishes with plugins created outside of our organization. These plugins can become officially approved by us, when they meet certain requirements. Then, when accepted, they will land on the official list of plugins on our website.
When a plugin is approved by Sylius, you can recognize it also by this badge below in its readme file:
How to have a Plugin approved by Sylius?¶
Since Sylius is an open-source platform, there is a certain flow in order for the plugin to become officially adopted by the community.
1. Develop the plugin using the official Plugin Development guide.
2. Remember about the tests and code quality! Check out Technical requirements for more details.
3. Send it to the project maintainers. It can be via email to any member of the Sylius Core team, or the official Sylius Slack.
4. One of our Plugin Curators will contact you with the feedback regarding your plugin’s code quality, test suite, and general feeling. They will also ask you to provide some changes in the code (if needed) to make this plugin approved.
5. Wait for your Plugin to be featured in the list of plugins on the Sylius website.
Below you can find a list of requirements that your plugin needs to fulfill to be approved by Sylius Core Team. Try to follow them, and your plugin’s approval process will be faster and more efficient!
Name of the plugin:
- Does the name clearly say what kind of feature the plugin provides?
- Does the plugin name contain the vendor’s name?
- Are all configuration roots and all classes appropriately named?
- Generally, does the plugin fulfills naming conventions?
- Does the plugin contain a description of its features?
- Is there a description of the plugin installation?
- Does the documentation consist of any screenshots (if the plugin provides any visual content)?
- Is it possible to install the plugin on a fresh Sylius-Standard application with no problems?
- Is every step needed for installation and configuration explained in the documentation? Are there any assumptions that could be confusing for less experienced developers?
- Are there any unit tests for the plugin’s classes? They can be written in PHPSpec, PHPUnit or any other working and reliable unit testing library
- Does the unit tests cover at least the most crucial classes in the plugin (those which contain important business logic)?
- Does the plugin contain some functional/acceptance tests (written in Behat/PHPUnit or similar tool)?
- Are the core features of the plugin described and tests by them?
- Does the code apply at least PSR-1?
- Does the code follow SOLID principles?
- Are conventions in the code consistent with each other (are the same conventions used for the same concepts)?
- Does the code apply some other PSR’s?
- Do unit tests cover most of the application classes?
- Do the functional/acceptance tests describe most of the application business-related features?
- Is there any CI tool used in the plugin’s repository (CircleCI, Travis CI, Jenkins)?