Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.74 KB

Contributing to Mandrel

Mandrel is a downstream distribution of GraalVM CE. As a result contributions to Mandrel should be limited to:

  1. Backports from the upstream repository of GraalVM (e.g. bringing a feature/bug-fix from GraalVM CE 20.2 to Mandrel 20.1)
  2. Mandrel specific bug fixes (e.g. patches to make it work with upstream OpenJDK instead of LabsJDK CE)
  3. Mandrel specific documentation

Anything not fitting the above list should probably be contributed upstream instead.

Workflow

Mandrel follows the github workflow. To contribute please fork this repository and open a pull request (PR).

Repository Structure

Mandrel, being a downstream distribution of GraalVM CE, is not developed on the default branch. Instead version specific branches, based on the corresponding GraalVM CE release, are used for development and maintenance. For instance, Mandrel 20.1.x.x releases are developed in the mandrel/20.1 branch. Similarly, Mandrel 20.2.x.x releases are developed in the mandrel/20.2 branch and so on.

The default branch is used only as a landing page and for hosting some housekeeping github actions workflows and templates.

In addition to the mandrel/XX.Y branches Mandrel also includes graal/X branches like graal/master. These branches are mirrors of the corresponding upstream branch and are being synchronized and tested nightly, in an effort to detect breaking changes upstream as soon as possible.

Oracle Contributor Agreement (OCA)

As part of the GraalVM community and similarly to OpenJDK, Mandrel requires contributors to sign the Oracle Contributor Agreement (OCA).