Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 3.33 KB

Contributing to GraalVM Community Edition for JDK 21 maintenance repository

The maintenance repository for GraalVM Community Edition for JDK 21 welcomes contributions from the community that satisfy the following criteria:

  1. The contributor has signed the Oracle Contributor Agreement. See https://www.graalvm.org/community/contributors/ for more information.
  2. The contribution contains a) replicas of existing commits applied to the master branch in the oracle/graal repository or b) patches specific to the maintained version. Such commits are intended to fix or improve existing features, must always keep release stability in mind, and ensure compatibility with published public APIs.
  3. The contribution is considered safe and beneficial for the GraalVM Community Edition for JDK 21. Ideally the contribution should be solving a reported issue and not be proactive.

Please note that feature requests and enhancements are not accepted in this repository. If you have a feature request or enhancement, please open an issue in GraalVM's main repository.

How to Contribute

Reporting Bugs

Open a GitHub issue filling in the template with the necessary information.

Fixing Bugs

  1. Make sure an issue report or backport request exists in this repository explaining what the problem is and why it should be considered for fixing in the maintenance repository.
  2. Make sure you have signed the Oracle Contributor Agreement.
  3. Create a pull request with the fix and reference the issue or backport request in the description.

Building GraalVM Community Edition for JDK 21

Please refer to the BUILDING.md file for instructions on how to build GraalVM Community Edition for JDK 21.

Running Style Checks

Before submitting a pull request, please run the following command to ensure that your changes comply with the GraalVM Community Edition code style:

../mx/mx --primary-suite vm --env ce checkstyle

ECLIPSE_TAR=eclipse.tar.gz
ECLIPSE_ORG_VERSION=$(jq -r '.eclipse.short_version' common.json)
ECLIPSE_ORG_TIMESTAMP=$(jq -r '.eclipse.timestamp' common.json)
wget --no-verbose https://archive.eclipse.org/eclipse/downloads/drops4/R-${ECLIPSE_ORG_VERSION}-${ECLIPSE_ORG_TIMESTAMP}/eclipse-SDK-${ECLIPSE_ORG_VERSION}-linux-gtk-x86_64.tar.gz -O $ECLIPSE_TAR
tar -xzf ${ECLIPSE_TAR}
ECLIPSE_EXE=${PWD}/eclipse/eclipse
../mx/mx --primary-suite vm --env ce eclipseformat --eclipse-exe $ECLIPSE_EXE

Note

The link used in the wget command above is only valid for linux x86_64. If you are using a different platform, please adjust the link accordingly.

Backporting Fixes

When backporting bug fixes use git cherry-pick -x to reference the original commit in the commit message. Additionally, please reference the upstream pull request that your changes are backporting. If the backport is partial explain which parts are being backported and why. Similarly in case of conflicts explain why they are happening and how they are resolved.