Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Plugins][Docs] Plugin technical requirements changes #10884

Merged

Conversation

Zales0123
Copy link
Member

Q A
Branch? 1.6
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Related tickets
License MIT

This PR contains changes from #10731, which in fact should be from the beginning opened to 1.6 馃槃

Due to the release of Sylius Store, I propose a slightly new approach to approving/accepting plugins. We want to develop our plugins ecosystem, but on the other hand, we still want to keep the high quality of these extensions. There is also a new way to propose plugins to our plugins list - a plugin request submit form.

So my proposal is to accept all the plugins that work, provide a valuable extension to Sylius features and is documented enough to make installation as less problematic as possible. On the other hand, only plugins that fulfill more strict requirements from the "Should have" section, can get an "Approved by Sylius" badge. I believe it will be a better change for both Sylius users and developers 馃弲 Let me know what you think about it 馃枛

@Zales0123 Zales0123 added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label Nov 27, 2019
@Zales0123 Zales0123 requested a review from a team as a code owner November 27, 2019 10:08
@@ -26,7 +26,7 @@ and even more. The limit is only your imagination (and business value, of course
our :doc:`customizing guide</customization/index>`.

At the end, do not hesitate to contact us at contact@sylius.com when you manage to implement a new plugin.
We would be happy to check it out and add it to our `official plugins list`_!
We would be happy to check it out and add it to our `approved plugins list`_!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to https://github.com/Sylius/Sylius/pull/10884/files#diff-a3cc58ce604fdb983d0d20d09c41893cR63 I think it could be interpreted as a list of approved plugins only.
WDYT about:

Suggested change
We would be happy to check it out and add it to our `approved plugins list`_!
We would be happy to check it out and add it to our `plugins list`_!

?

* 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 :ref:`naming conventions <book_plugins_creating_plugin_naming_conventions>`?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Generally, does the plugin fulfills :ref:`naming conventions <book_plugins_creating_plugin_naming_conventions>`?
* Generally, does the plugin fulfill :ref:`naming conventions <book_plugins_creating_plugin_naming_conventions>`?

If you want your plugin to be officially approved by Sylius Core Team, there are more things to do. Only plugins with the
highest standards of code and properly developed test suite could get the "Approved by Sylius" mark, which makes them more
visible in the community and ensures users about their quality.
When Sylius approve a plugin, you can recognize it also by this badge below in its readme file:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When Sylius approve a plugin, you can recognize it also by this badge below in its readme file:
When Sylius approves a plugin, you can recognize it also by this badge below in its readme file:

@lchrusciel lchrusciel merged commit cf7e2e5 into Sylius:1.6 Dec 11, 2019
@lchrusciel
Copy link
Member

Thank you, Mateusz! 馃帀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants