DEVELOPER_GUIDE.md

• Developer Guide
  • Forking and Cloning
  • Install Prerequisites
    • JDK 21
  • Building
  • Using IntelliJ IDEA
  • Submitting Changes

Developer Guide

So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.

Forking and Cloning

Fork this repository on GitHub, and clone locally with git clone.

Install Prerequisites

JDK 21

OpenSearch components build using Java 21 at a minimum. This means you must have a JDK 21 installed with the environment variable JAVA_HOME referencing the path to Java home for your JDK 21 installation, e.g. JAVA_HOME=/usr/lib/jvm/jdk-21.

Building

To build from the command line, use ./gradlew.

./gradlew clean
./gradlew build
./gradlew publishToMavenLocal

Using IntelliJ IDEA

Launch Intellij IDEA, choose Import Project, and select the settings.gradle file in the root of this package.

Submitting Changes

See CONTRIBUTING.

Backport

• Link to backport documentation