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

Update index.md #1564

Merged
merged 3 commits into from
Nov 29, 2024
+16 −10
Merged

Update index.md #1564

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
459778c
Update index.md
mboelt Nov 18, 2024
71f4dc0
added some changes
sushmangupta Nov 28, 2024
5682a3f
Merge branch 'main' into patch-14
sushmangupta Nov 29, 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
26 changes: 16 additions & 10 deletions resources/guidelines/testing/store/quality-guidelines-apps/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
nav:
title: Quality guidelines for apps in the plugin system
title: Quality guidelines for apps and themes in the app system
position: 10

---

# Quality Guidelines for the Plugin System in the Shopware Store
# Quality Guidelines for apps and themes based on the app system in the Shopware Store

> **Changelog**
>
Expand Down Expand Up @@ -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]).

Link: [Differentiator cluster for Shopware extensions](/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)
[Differentiator cluster for Shopware extensions](/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)

::: info
**Safe your app idea and get a preview in the store**
Expand Down Expand Up @@ -234,8 +235,9 @@ This allows other developers to review and understand the code in its original,

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](/docs/guides/plugins/plugins/administration/add-custom-field.html#loading-the-js-files)
Link: [Injecting into the Administration](/docs/guides/plugins/plugins/administration/add-custom-field.html#injecting-into-the-administration)
[Loading the JS files](/docs/guides/plugins/plugins/administration/add-custom-field.html#loading-the-js-files)

[Injecting into the Administration](/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 @@ -367,7 +369,7 @@ 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.

* Link: [Code reviews for Shopware 6 on GitHub](https://github.com/shopwareLabs/store-plugin-codereview)
* [Code reviews for Shopware 6 on GitHub](https://github.com/shopwareLabs/store-plugin-codereview)

### Sonarcube Rules status Blocker

Expand All @@ -391,16 +393,17 @@ The technical app name must be stored in the first part of manifest.xml.
Most of the errors are caused by the wrong technical name.
For example, "Swag\\MyPlugin\\SwagMyPluginSW6" instead of "Swag\\MyPlugin\\SwagMyPlugin".

[Here is an example](https://developer.shopware.com/docs/resources/references/app-reference/manifest-reference.html#manifest-reference) of a valid manifest.xml.
[Example of a valid manifest.xml](https://developer.shopware.com/docs/resources/references/app-reference/manifest-reference.html#manifest-reference)

### 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.
["Cross-document messaging domains should be carefully restricted"](https://rules.sonarsource.com/javascript/RSPEC-2819)

### Class Shopware\Storefront\* not found

Missing requirements in the theme.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.

[Shopware App Development: App Meta Information - Explanation of the properties](../../../../../guides/plugins/plugins/plugin-base-guide#the-composerjson-file)

### Cookies are written safely

Expand All @@ -419,6 +422,7 @@ The `composer.lock` in the app archive has to be deleted.
Remove out-commented code, unused files and folders, and all dev-files from your binary.

Here are some examples of not allowed folders and files:

* /__MACOSX
*./tests
* .gitignore
Expand All @@ -434,9 +438,11 @@ Here are some examples of not allowed folders and files:
* .tar
* .tar.gz
* .zip
* .zipignore
* composer.lock
* package.json
* package-lock.json
* phpunit.sh
* phpdoc.dist.xml
* phpstan.neon
* phpstan.neon.dist
Expand Down
Loading