-
Notifications
You must be signed in to change notification settings - Fork 260
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.
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
Open
mboelt
wants to merge
1
commit into
shopware:main
Choose a base branch
from
mboelt:patch-14
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update index.md #1564
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
|---|---|---|
| @@ -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 app system in the Shopware Store | ||
|
|
||
| > **Changelog** | ||
| > | ||
|
|
@@ -58,6 +58,7 @@ If an extension with the same function exists and it does not fit into one of ou | |
| 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) | ||
|
|
||
| ::: info | ||
|
|
@@ -127,7 +128,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. | ||
|
|
||
| [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 | ||
|
|
||
|
|
@@ -235,6 +236,7 @@ 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) | ||
|
|
||
| Shopware reserves the right to publish extensions with minified code after individual consideration and consultation with the developer. | ||
|
|
@@ -389,16 +391,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. | ||
| Link: [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. | ||
| Link: ["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. | ||
|
|
||
| Link: [Shopware App Development: App Meta Information - Explanation of the properties](../../../../../guides/plugins/plugins/plugin-base-guide#the-composerjson-file) | ||
|
|
||
| ### Cookies are written safely | ||
|
|
||
|
|
@@ -432,9 +435,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 | ||
| * phpunitx.xml | ||
| * shell.nix | ||
| * Thumbs.db | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one is tricky. Isn't "Plugin system" the official way of saying "Apps, themes and plugins"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. We differentiate between apps based on the plugin system and apps based on the app system. So, an app could be both a cloud app and a plugin app.
Don`t ask me. I know that this is confusing ;-) but we had to officially communicate this from shopware 6 on.
Therefore, the navigation had to change as we have two different documents (guidelines for apps based on the app system and guidelines for apps based on the plugin system) with the same nav title. I guess we had 2 different nav titles in the past, but due to the restructuring of the guidelines, we simply overwrote it by copying and pasting and did not recognize that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I recognized a minor grammar mistake.
The headline should be named like this:
Quality Guidelines for apps and themes based on the app system in the Shopware Store
It would be nice if you could fix that before approving. Thanks.