Magento Marketplace User Guide

Submit for Technical Review

When you have completed the code you can submit your extension for Technical and/or Marketing Review. The extension is placed in a queue as soon as it is submitted. You will receive confirmation by email, and can track the status of your submission from your Marketplace account.

If your extension makes use of Shared Packages — or components — they must be ready to use before you can associate them with your submission. You will not be able to submit your extension to Technical Review until the shared packages that are used by the extension are available in your account.

 

  • Field

    Description

    Magento Version Compatibility

    Specifies each version of Magento that is supported by the extension.

    License Type

    Identifies the license type that defines the terms of use. To learn more, see the Open Source Initiative’s Licenses by Name. Options:

    Custom License

    To use a custom license, enter the Name of the license, and the License URL, where customers can read the terms of use.

    Academic Free License 3.0

    The Academic Free License 3.0 (AFL) is an open source license that permits the free distribution and reuse of proprietary software and derivative works, provided that the source code is made available.

    Apache License 2.0

    The Apache License 2.0 describes the terms of use, reproduction, and distribution of third-party software products that include portions of Apache software. It requires clear attribution to The Apache Software Foundation for any distributions that include Apache software.

    BSD 2-Clause License

    The Berkeley Software Distribution 2-Clause License requires the copyright notice to appear in all source code, but imposes minimal restrictions on the redistribution of open source software. The 2-clause license was derived from the original 4-clause BSD license which requires a notice to appear in all advertising and prohibits the use of the contributor names in endorsements without prior written permission.

    GNU General Public License 3.0

    The GNU General Public License 3.0 (GLP-3.0) is widely used and based on the GNU open source license, and allows for the redistribution of software received from the copyright holder within the provisions outlined in the agreement. Any improved version of the software must be made available for free. To learn more, see: Frequently Asked Questions about GNU Licenses.

    GNU Lesser General Public License 3.0

    The GNU Lesser General Public License 3.0 (LGPL-3.0) is widely used and based on the GNU open source license. LGPL03.0 is somewhat less restrictive than the standard GLP-3.0, and also requires that you provide installation instructions. To learn more, see: Frequently Asked Questions about GNU Licenses.

    MIT License

    The Massachusetts Institute of Technology License (MIT) allows for the reuse, modification, distribution, sublicensing, and sale of proprietary software, provided that all copies include the MIT license and copyright notice.

    Mozilla Public License 1.1

    The Mozilla Public License 1.1 (MPL-1.1) is an open source license that includes explicit patent rights and allows extensions of the code to be licensed in non-open ways. There is no requirement for a derivative work to be distributed under the same license.

    Open Software License 3.0

    The Open Software License 3.0 (OSL-3.0) is a worldwide, royalty-free, non-exclusive license that allows sublicensing and derivative work, provided that they are distributed under the same license.

    Documents

    Upload your customer-facing documentation in PDF format. The user guide is required, and you can optionally include a reference manual and installation guide. The maximum file size for each PDF is 5 MB.

    User Guide

    Your extension must include one user guide.

    Reference Manual

    (Optional)

    Installation Guide

    (Optional)

    Although the installation guide is optional, it might be required by some license types.

    Release Notes

    The preliminary Release Notes text can include simple HTML, without CSS. Maximum characters: 10,000

    Shared Packages

    If applicable, identifies each shared package that is required by this extension.