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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Update index.md #1565

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Update index.md #1565

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c59c88a
Update index.md
mboelt Nov 18, 2024
6352eb6
Update resources/guidelines/testing/store/quality-guidelines-plugins/…
bojanrajh Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 26 additions & 21 deletions resources/guidelines/testing/store/quality-guidelines-plugins/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
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]).

Expand All @@ -57,8 +57,9 @@
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**
Expand Down Expand Up @@ -128,7 +129,7 @@
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

Expand Down Expand Up @@ -253,10 +254,11 @@
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.
Expand Down Expand Up @@ -311,16 +313,16 @@
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

Expand Down Expand Up @@ -356,8 +358,8 @@
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:

Check warning on line 361 in resources/guidelines/testing/store/quality-guidelines-plugins/index.md

View workflow job for this annotation

GitHub Actions / Runner 

[LanguageTool] reported by reviewdog 🐶
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING

Raw Output:
resources/guidelines/testing/store/quality-guidelines-plugins/index.md:361:79: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING
* Link: [Github](https://github.com/shyim/ShyimApiTest)
bojanrajh marked this conversation as resolved.
Show resolved Hide resolved

### Shopping experiences

Expand Down Expand Up @@ -396,26 +398,26 @@

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

Expand All @@ -428,11 +430,11 @@
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

Expand All @@ -442,7 +444,8 @@
### 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

Expand Down Expand Up @@ -515,9 +518,11 @@
* .tar
* .tar.gz
* .zip
* .zipognore
* composer.lock
* package.json
* package-lock.json
* phpunit.sh
* phpunitx.xml
* shell.nix
* Thumbs.db
Expand Down
Loading