-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update index.md Fixed some linebreaks. * Update resources/guidelines/testing/store/quality-guidelines-plugins/index.md --------- Co-authored-by: Bojan Rajh <[email protected]>
- Loading branch information
Showing
1 changed file
with
26 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,7 +37,7 @@ So set it to the actual SW6 version e.g., shopware/testenv:6.6.6. | |
| Always test with the app`s highest supported Shopware version. | ||
| ::: | ||
|
|
||
| [Test your app for the Shopware Store (DE):](https://www.youtube.com/watch?v=gLb5CmOdi4g) and EN version is coming soon. | ||
| Link: [Test your app for the Shopware Store (DE):](https://www.youtube.com/watch?v=gLb5CmOdi4g) and EN version is coming soon. | ||
|
|
||
| **Progressive Web App:** If your app is PWA compatible and you would like the PWA flag, please contact us at [[email protected]](mailto:[email protected]). | ||
|
|
||
|
|
@@ -57,8 +57,9 @@ Hence, we check for a functional comparison with other apps already in the Shopw | |
| If an extension with the same function exists and it does not fit into one of our differentiator clusters, it can be rejected as it doesn't provide any added value. | ||
| If you would like more information, please write an email to [[email protected]](mailto:[email protected]). | ||
|
|
||
| [Differentiator cluster for Shopware extensions](https://developer.shopware.com/docs/resources/guidelines/testing/Differentiator-Clusters.html) | ||
| [Documentation for Extension Partner](https://docs.shopware.com/en/account-en/extension-partner/extensions?category=account-en/extension-partner#how-can-i-request-a-preview) | ||
| Link: [Differentiator cluster for Shopware extensions](https://developer.shopware.com/docs/resources/guidelines/testing/Differentiator-Clusters.html) | ||
|
|
||
| Link: [Documentation for Extension Partner](https://docs.shopware.com/en/account-en/extension-partner/extensions?category=account-en/extension-partner#how-can-i-request-a-preview) | ||
|
|
||
| ::: info | ||
| **Safe your app idea and get a preview in the store** | ||
|
|
@@ -128,7 +129,7 @@ Include several screenshots and descriptive images from the Storefront and backe | |
| They must show the app "in action", its configuration options, and how to use it. | ||
| We recommend uploading screenshots showing the mobile and desktop-view. | ||
|
|
||
| Take a look at [How To - Add images and icons to extensions](https://docs.shopware.com/en/account-en/adding-pictures-and-icons/how-to) | ||
| Link: [How To - Add images and icons to extensions](https://docs.shopware.com/en/account-en/adding-pictures-and-icons/how-to) | ||
|
|
||
| ### Link to demoshop | ||
|
|
||
|
|
@@ -253,10 +254,11 @@ However, it is difficult to read and understand the compiled code. | |
| The uncompiled JavaScript code must be placed in a separate folder to ensure it remains accessible to all developers. | ||
| This allows other developers to review and understand the code in its original, readable form. | ||
|
|
||
| Please build your `main.js` as described in our documentation and create the minified code as described in our developer documentation. | ||
| Please build your `main.js` as described in our documentation and create the minified code as described in our developer documentation. | ||
|
|
||
| Link: [Loading the JS files](https://developer.shopware.com/docs/guides/plugins/plugins/administration/add-custom-field.html#loading-the-js-files) | ||
|
|
||
| [Loading the JS files](https://developer.shopware.com/docs/guides/plugins/plugins/administration/add-custom-field.html#loading-the-js-files) | ||
| [Injecting into the Administration](https://developer.shopware.com/docs/guides/plugins/plugins/administration/add-custom-field.html#injecting-into-the-administration) | ||
| Link: [Injecting into the Administration](https://developer.shopware.com/docs/guides/plugins/plugins/administration/add-custom-field.html#injecting-into-the-administration) | ||
|
|
||
| Shopware reserves the right to publish extensions with minified code after individual consideration and consultation with the developer. | ||
| For this, the developer must ensure that Shopware has access to the current unminified code of the extension at all times. | ||
|
|
@@ -311,16 +313,16 @@ Could you do an A/B test with *Lighthouse Audit* to check the performance and qu | |
| There should not be any drastic change in performance, accessibility values, or any new errors when activating the app. | ||
|
|
||
| * **Testing tool** for A/B-Testing: | ||
| * [Google Lighthouse](https://developers.google.com/web/tools/lighthouse) | ||
| * Link: [Google Lighthouse](https://developers.google.com/web/tools/lighthouse) | ||
|
|
||
| ### schema.org/Rich Snippets A/B-Testing: | ||
|
|
||
| Do an A/B-Test with *Scheme.org's Structured Data Testing Tool* and *Google Rich Result Tester* to check the homepage, categories, and various product detail pages (incl. available products, unavailable products, products with no review, single review, many reviews with various ratings, out-of-stock products, products to be released in the future or any other kind of product configuration and products including ean, mpn, width, length, height, weight). | ||
| Also, could you check for duplicate entries as well as any new bugs? | ||
|
|
||
| * **Testing tool** for A/B-Testing: | ||
| * [Schema Markup Validator of schema.org](https://validator.schema.org/) | ||
| * [Google Rich Result Tester](https://search.google.com/test/rich-results) | ||
| * Link: [Schema Markup Validator of schema.org](https://validator.schema.org/) | ||
| * Link: [Google Rich Result Tester](https://search.google.com/test/rich-results) | ||
|
|
||
| ### Usage of fonts from external sources | ||
|
|
||
|
|
@@ -356,8 +358,8 @@ Apart from that, you can validate the required credentials while saving them in | |
| In this case, a status message must be displayed in the administration and Shopware log. | ||
| If the API data is incorrect, an entry must appear in the event log file in the Shopware folder `/var/log/` respectively in the database. | ||
|
|
||
| * **Example for implementing an API Test Button into the System Config form: | ||
| * [Github](https://github.com/shyim/ShyimApiTest) | ||
| * **Example** for implementing an API Test Button into the System Config form: | ||
| * Link: [GitHub](https://github.com/shyim/ShyimApiTest) | ||
|
|
||
| ### Shopping experiences | ||
|
|
||
|
|
@@ -396,26 +398,26 @@ Below is an example of implementing the tracking logic in their extensions: | |
|
|
||
| Our most current code review configurations when uploading apps via the Shopware Account can be found on GitHub. | ||
|
|
||
| * [Code reviews for Shopware 6 on GitHub](https://github.com/shopwareLabs/store-plugin-codereview) | ||
| * Link: [Code reviews for Shopware 6 on GitHub](https://github.com/shopwareLabs/store-plugin-codereview) | ||
|
|
||
| ### Sonarcube Rules status Blocker | ||
|
|
||
| The following statements will be blocked as of 1st Oct. 2022: | ||
| -die; exit; var_dump | ||
|
|
||
| * [Refer to the list of the already existing blockers](https://s3.eu-central-1.amazonaws.com/wiki-assets.shopware.com/1657519735/blocker.txt). | ||
| * Link: [Refer to the list of the already existing blockers](https://s3.eu-central-1.amazonaws.com/wiki-assets.shopware.com/1657519735/blocker.txt). | ||
|
|
||
| ### Automated code tests with Cypress | ||
|
|
||
| There are Cypress tests for Shopware 6 on GitHub. | ||
| The project is driven by the *Friends of Shopware* group. You can contribute at any time: | ||
|
|
||
| * [Developer Documentation Cypress Tests for Shopware 6](/docs/guides/plugins/plugins/testing/end-to-end-testing) | ||
| * [Cypress Tests for Shopware 6](https://github.com/shopware/shopware/tree/trunk/src/Administration/Resources) | ||
| * Link: [Developer Documentation Cypress Tests for Shopware 6](/docs/guides/plugins/plugins/testing/end-to-end-testing) | ||
| * Link: [Cypress Tests for Shopware 6](https://github.com/shopware/shopware/tree/trunk/src/Administration/Resources) | ||
|
|
||
| ### Helpful tools for app developers | ||
| * [FroshPluginUploader](https://github.com/FriendsOfShopware/FroshPluginUploader): Tool for validating and uploading new SW6 app releases to the Community Store (GitHub Project from "Friends of Shopware")] | ||
| * [Shopware CLI tools](https://github.com/shopwareLabs/sw-cli-tools): When you think about performance, these are various useful console helpers for generating data. | ||
| * Link: [FroshPluginUploader](https://github.com/FriendsOfShopware/FroshPluginUploader) Tool for validating and uploading new SW6 app releases to the Community Store (GitHub Project from "Friends of Shopware"). | ||
| * Link: [Shopware CLI tools / console helpers](https://github.com/shopwareLabs/sw-cli-tools) | ||
|
|
||
| ## Automatic code review - Errors | ||
|
|
||
|
|
@@ -428,11 +430,11 @@ The technical app name must be stored in the composer.json, located at `composer | |
| Could you take a look at the bootstrap class? Most of the errors are caused by the wrong technical name. | ||
| For example, "Swag\\MyPlugin\\SwagMyPluginSW6" instead of "Swag\\MyPlugin\\SwagMyPlugin". | ||
|
|
||
| [Example of a valid composer.json](https://github.com/FriendsOfShopware/FroshPlatformPerformance/blob/master/composer.json#L20). | ||
| Link: [Example of a valid composer.json](https://github.com/FriendsOfShopware/FroshPlatformPerformance/blob/master/composer.json#L20). | ||
|
|
||
| ### Ensure cross-domain messages are sent to the intended domain | ||
|
|
||
| See ["Cross-document messaging domains should be carefully restricted"](https://rules.sonarsource.com/javascript/RSPEC-2819) for more information. | ||
| Link: ["Cross-document messaging domains should be carefully restricted"](https://rules.sonarsource.com/javascript/RSPEC-2819) | ||
|
|
||
| ### No bootstrapping file found. Expecting bootstrapping in | ||
|
|
||
|
|
@@ -442,7 +444,8 @@ The reasons could be that the folder structure in the ZIP file needs to be corre | |
| ### Class Shopware\Storefront\* not found | ||
|
|
||
| Missing requirements in the composer.json (e.g. "require": {"shopware/frontend": "*"},) | ||
| See "[Shopware App Development: App Meta Information - Explanation of the properties](../../../../../guides/plugins/plugins/plugin-base-guide#the-composerjson-file) for more information. | ||
|
|
||
| Link: "[Shopware App Development: App Meta Information - Explanation of the properties](../../../../../guides/plugins/plugins/plugin-base-guide#the-composerjson-file) | ||
|
|
||
| ### Cookies are written safely | ||
|
|
||
|
|
@@ -517,9 +520,11 @@ Here are some examples of not allowed folders and files: | |
| * .tar | ||
| * .tar.gz | ||
| * .zip | ||
| * .zipognore | ||
| * composer.lock | ||
| * package.json | ||
| * package-lock.json | ||
| * phpunit.sh | ||
| * phpunitx.xml | ||
| * shell.nix | ||
| * Thumbs.db | ||
|
|
||