CONTRIBUTING.md

Contributing to Substrait Java

This page provides some orientation and recommendations on how to get the best results when engaging with the community.

1. Commit conventions
2. Style Guide

Commit Conventions

Substrait Java follows conventional commits for commit message structure. You can use pre-commit to check your messages for you, but note that you must install pre-commit using pre-commit install --hook-type commit-msg for this to work. CI will also lint your commit messages. Please also ensure that your PR title and initial comment together form a valid commit message; that will save us some work formatting the merge commit message when we merge your PR.

$ pre-commit install --hook-type commit-msg
pre-commit installed at .git/hooks/commit-msg

Examples of commit messages can be seen here.

Style guide

Changes must adhere to the style guide and this will be verified by the continuous integration build.

• Java code style is Google style.

Java code style is checked by Spotless with google-java-format during the build.

Automatically fixing code style issues

Java code style issues can be fixed from the command line using ./gradlew spotlessApply.

Configuring the Code Formatter for Intellij IDEA and Eclipse

Follow the instructions for Eclipse or IntelliJ, note the required manual actions for IntelliJ.

Gradle & JDK 17

Given that the project currently uses JDK 17 features, it requires to run Gradle itself with JDK 17, which in turn requires the below settings in ~/.gradle/gradle.properties. Without those settings you might see issues when running ./gradlew spotlessApply.

org.gradle.jvmargs=--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \
  --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED