Setting up development environment

March 21, 2026 ยท View on GitHub

  1. Check out this repository.
  2. Open the project in IntelliJ IDEA.
  3. Make sure that you are on the latest develop branch (for example 5.4.0-develop).
  4. Import the Gradle project from build.gradle.kts.
  5. Use JDK 21 for both the project SDK and the Gradle JVM.
  6. In the Gradle tool window, run Tasks > Intellij platform > runIde.
  7. The task launches a PhpStorm sandbox with the plugin installed. Make sure that the plugin is enabled and indexing is finished before testing features.

Plugin publication

  1. Build a new version of the plugin
  2. Install the newly created archive/jar file from disk for testing
  3. Publish

Contribution process

If you are a new GitHub user, we recommend that you create your own free github account. This will allow you to collaborate with the Magento 2 development team, fork this project and send pull requests.

  1. Search current listed issues (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
  2. Review and sign the Contributor License Agreement (CLA) if this is your first time contributing. You only need to sign the CLA once.
  3. Create and test your work.
  4. Fork this repository and create a pull request.
  5. Once your contribution is received the Magento 2 development team will review the contribution and collaborate with you as needed.