From fa35ec9a70aafe309a04b38e126cb072fd383a74 Mon Sep 17 00:00:00 2001 From: "Vlad (SW)" <119918965+Swvla@users.noreply.github.com> Date: Fri, 27 Mar 2026 15:16:08 +0100 Subject: [PATCH] Update quality-guidelines.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We had to revise the documentation because, unfortunately, the content was incorrect. The “App / Plugin” part has been removed from the name, so it is now called “Ales Extension.” --- .../monetization/quality-guidelines.md | 585 +++++++++++------- 1 file changed, 347 insertions(+), 238 deletions(-) diff --git a/guides/development/monetization/quality-guidelines.md b/guides/development/monetization/quality-guidelines.md index 09b523c6e..fe8004d47 100644 --- a/guides/development/monetization/quality-guidelines.md +++ b/guides/development/monetization/quality-guidelines.md @@ -1,327 +1,436 @@ ---- -nav: - title: Quality Guidelines for Store Extensions - position: 20 +nav:\ +title: Quality guidelines for apps in the plugin system\ +position: 20 ---- +* * * * * -# Quality Guidelines for Store Extensions +Quality Guidelines for the Plugin System in the Shopware Store +============================================================== These guidelines apply to all extensions distributed via the Shopware Store, including both plugins and apps. They define the quality, security, and compliance requirements for publication. -## Scope and terminology +Scope and terminology -* **Extension**: umbrella term for plugins and apps. -* **Plugin**: installed in the Shopware instance; PHP code, Composer. -* **App**: integrated via app system; no direct PHP execution in core. +- **Extension**: umbrella term for plugins and apps. + +- **Plugin**: installed in the Shopware instance; PHP code, Composer. + +- **App**: integrated via app system; no direct PHP execution in core. Unless stated otherwise, requirements apply to all extensions. -## Review process +What kind of extension is allowed? +---------------------------------- + +Currently, all types of extensions are allowed, except those that violate the following regulations. Extensions with the functions listed below are not permitted and will not be approved: + +- Function that included in the shopware B2B Components - [Shopware 6 - Commercial Features - B2B Components](https://docs.shopware.com/en/shopware-6-en/commercial-features/b2b-components) + +- Direct SQL adjustments by user or other security relefant issues + +- Extensions that are two major versions below the current one + +- If your extensionis a software app/interface with downstream costs, transaction fees, or service fees for the customer, we need to complete a technology partner agreement in order to activate your app. + +Review process +-------------- All extensions are: -1. Automatically [code-reviewed](https://github.com/shopwareLabs/store-plugin-codereview) (PHPStan, SonarQube), due to our quality assurance, with special attention on impacts to the Administration and Storefront. -2. Manually reviewed for security, coding standards, user experience, and functionality. -3. Tested on the latest stable [Shopware 6](https://www.shopware.com/de/download/#shopware-6) CE version. +1. Automatically [code-reviewed](https://github.com/shopwareLabs/store-plugin-codereview "https://github.com/shopwareLabs/store-plugin-codereview") (PHPStan, SonarQube), due to our quality assurance, with special attention on impacts to the Administration and Storefront. + +2. Manually reviewed for security, coding standards, user experience, and functionality. + +3. Tested on the latest stable [Shopware 6](https://www.shopware.com/de/download/#shopware-6 "https://www.shopware.com/de/download/#shopware-6") CE version. Always test against the highest supported Shopware 6 version (e.g., `shopware/testenv:6.7.6`). For apps, we additionally test: -* `config.xml` per sales channel -* Install/uninstall behavior -* Styling and viewport issues +- `config.xml` per sales channel + +- Install/uninstall behavior + +- Styling and viewport issues Before publishing an extension, review the full test process to ensure fast approval. -::: info -[Test your app for the Shopware Store (DE):](https://www.youtube.com/watch?v=gLb5CmOdi4g); EN version is coming soon. -::: +Checklist for testing +--------------------- -## Store listing requirements +- We pay attention to the automatic code review and look for security issues and shopware coding standards in the manual code review. -All extensions must: +- We check the complete functionality of the extension and check for styling errors on every viewport. -* Be available in English, with 1:1 translation between English and German. For the German store, German language is required. All extensions will be released in both the German and International stores. -* Use meaningful short and long descriptions. - * The short description (150–185 characters) teases your extension in an overview, along with "Customers also bought" and "Customers also viewed" recommendations. It is also published as a meta-description. - * Long descriptions (minimum 200 characters) must describe the extension's functionality in detail. -* Accurately and clearly describe the extension and its use cases. -* Avoid the words “plugin” and “shopware” in the display name. -* Avoid blank spaces as filler text. -* Include clear, complete setup and configuration instructions. -* Use clean HTML source code. Inline styles will be stripped. +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 "https://docs.shopware.com/en/account-en/extension-partner/extensions?category=account-en/extension-partner#how-can-i-request-a-preview") -These tags are allowed: +Extension store description +--------------------------- -```markdown -