Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (21 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.54 KB

Getting started

Clone

git clone https://github.com/JetBrains/educational-plugin
cd educational-plugin

Configuring development environment

  1. Java 21 is required for development. For example, you can install openJDK or Amazon Corretto
  2. Open project directory in IntelliJ IDEA. You can get the latest IntelliJ IDEA here.
  3. Import Gradle project. If you are not familiar with IntelliJ IDEA Gradle integration, check out the documentation
  4. You can modify gradle.properties if needed
  5. For running and debugging plugin with IntelliJ IDEA, PyCharm, CLion, WebStorm, GoLand, and Rider predefined run configurations runIdea, runPyCharm, runCLion, runWebStorm, runGoLand, and runRider should be used
  6. To build plugin distribution use :intellij-plugin:buildPlugin Gradle task. It creates an archive at intellij-plugin/build/distributions which can be installed into your IDE via Install plugin from disk... action found in Settings > Plugins.

Supporting different platforms

The plugin supports several versions of the IntelliJ platform and several different IDEs. See different-platform-versions.md for details on how multi-platform support is organized in the project, how to write platform-specific code, and how to support new platform versions or drop old ones.