Update quality-guidelines.md#2207
Conversation
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.”
|
Vlad (SW) (@Swvla), please don't change the front matter at the top. This will break the page. If AI was used, please revise it to follow the other file patterns. As for the changes, we don't use seperators etc. "----------------------------------" I recommend redoing the PR with only relevant changes, and also please check grammar and language. For the name changes, please be in touch with somethings (@lasomethingsomething) to find the best solution in the middle while keeping the content clear. |
There was a problem hiding this comment.
Pull request overview
Updates the monetization quality guidelines documentation used by extension partners, with the intent (per PR description) to correct naming/terminology and revise the guidance.
Changes:
- Reworked the document structure and headings, expanding sections on review/testing, store listing requirements, and common code review errors.
- Updated/rewrote multiple guideline statements, links, and examples throughout the page.
- Adjusted terminology used across the document (though it currently appears inconsistent with the PR description).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| nav:\ | ||
| title: Quality guidelines for apps in the plugin system\ | ||
| position: 20 | ||
|
|
||
| --- | ||
| * * * * * |
There was a problem hiding this comment.
The page metadata/frontmatter is no longer valid YAML frontmatter: it’s missing the --- delimiters and nav: is followed by a literal \ (and title/position are no longer nested under nav). This likely breaks navigation generation for the guides (compare e.g. guides/development/monetization/index.md).
|
|
||
| --- | ||
| * * * * * | ||
|
|
There was a problem hiding this comment.
The horizontal rule * * * * * immediately after the metadata is nonstandard for this docs set and will render as body content. If the intent was to separate frontmatter from content, restore the usual --- frontmatter block and remove this separator.
|
|
||
| Run a [Google Lighthouse](https://developer.chrome.com/docs/lighthouse "https://developer.chrome.com/docs/lighthouse") audit before and after activating the extension. | ||
|
|
||
| Significant regressions in performance, accessibility, best practices, or SEO are allowed. No new console errors may be introduced. |
There was a problem hiding this comment.
This sentence reverses the intended requirement: “Significant regressions … are allowed” contradicts the following sentence (“No new console errors may be introduced”) and typical quality guidelines. It should state that significant regressions are not allowed.
| Significant regressions in performance, accessibility, best practices, or SEO are allowed. No new console errors may be introduced. | |
| Significant regressions in performance, accessibility, best practices, or SEO are not allowed. No new console errors may be introduced. |
| ### schema.org/rich snippets A/B-testing checklist | ||
| ### [schema.org/Rich](http://schema.org/Rich "http://schema.org/Rich") Snippets A/B-Testing | ||
|
|
||
| Do an A/B-Test with [The Scheme Programming Language](http://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). |
There was a problem hiding this comment.
This section appears to confuse “schema.org” with the “Scheme” programming language: it links to scheme.org and refers to “The Scheme Programming Language’s Structured Data Testing Tool”. This is incorrect/misleading for structured data validation and should refer to schema.org tooling (Schema Markup Validator / Google Rich Results) without mentioning Scheme.
| Do an A/B-Test with [The Scheme Programming Language](http://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). | |
| Do an A/B-Test with the *Schema Markup Validator* and the *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). |
| Developer documentation article to add private dependency | ||
|
|
There was a problem hiding this comment.
The “Developer documentation article to add private dependency” line is a dangling heading/sentence without a link or content. Either provide the referenced documentation link or remove the line to avoid confusing readers.
| Developer documentation article to add private dependency |
|
|
||
| - 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. |
There was a problem hiding this comment.
Missing space in “extensionis” makes the sentence harder to read; it should be “extension is”.
| - 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. | |
| - If your extension is 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. |
|
|
||
| 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) |
There was a problem hiding this comment.
Grammar: “Function that included …” should be pluralized/rephrased (e.g., “Functions that are included …”) since it introduces a list of disallowed capabilities.
| - 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) | |
| - Functions that are included in the Shopware B2B Components - [Shopware 6 - Commercial Features - B2B Components](https://docs.shopware.com/en/shopware-6-en/commercial-features/b2b-components) |
| 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 | ||
| ============================================================== |
There was a problem hiding this comment.
PR description says the naming should be updated to “Ales Extension”, but the updated title/heading still uses “apps”, “plugin system”, and “extensions”. Please align the terminology in the page title and headings with the intended new product name, or update the PR description if the rename target is different.
| <a> <p> <br> <b> <strong> <i> <ul> <ol> <li> <h2> <h3> <h4> <h5> | ||
| ``` | ||
| The release to the international store is standard, the German store is optional.\ | ||
| As an extension will be released in both stores (German and international), the content must accurately translate 1:1 from English to German. |
There was a problem hiding this comment.
These two sentences contradict each other: first the German store is “optional”, then it says the extension “will be released in both stores”. Clarify whether German listing is required or optional and adjust the translation requirement accordingly.
| As an extension will be released in both stores (German and international), the content must accurately translate 1:1 from English to German. | |
| If an extension is released in both stores (German and international), the content must accurately translate 1:1 from English to German. |
|
|
||
| ### Call to static method jsonEncode() on an unknown class | ||
|
|
||
| Shopware always uses json_Encode exclusively - there is no other fallback. |
There was a problem hiding this comment.
Typo in function name: “json_Encode” should be “json_encode” (and the statement should reference the actual PHP function name to avoid confusion).
| Shopware always uses json_Encode exclusively - there is no other fallback. | |
| Shopware always uses json_encode exclusively - there is no other fallback. |
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.”