Skip to content

Contribute

Contributions are welcome. If you use AI tools, read the AI policy first.

Process

  1. Fork the repository and clone it.
  2. Create a branch, for example feat/my-feature or fix/my-bug.
  3. Make the change, with unit tests for new logic. Changes to the cloud backends also need integration tests.
  4. Build with ./mvnw verify. The build formats the code.
  5. Open a pull request against main.

The pull request template lists what a pull request needs before the merge:

  • New unit tests cover the change.
  • The documentation is updated, if users can see the change.
  • A GitHub issue describes the change, unless users see no difference.
  • A bug fix or a small feature is a single commit, and each commit has a single goal.

The pull request is merged when the build checks are green, a maintainer has reviewed it, and the checklist is complete.

Coding standards

  • Target Java 17. The build runs on JDK 25 and compiles for Java 17: the compiler rejects an API added after Java 17.
  • Follow the Palantir Java Format. The build applies it.
  • Start each Java file with the license header from license_header.txt. The build adds it, except to package-info.java files.
  • Document the public API with javadoc.
  • Return Optional<T> for a value that may be missing. Avoid returning null.

Commit messages

Commit titles follow Conventional Commits:

  • feat: add GCS support
  • fix: handle EOF correctly in range reader
  • docs: update usage examples
  • chore: bump dependencies

Releases

GitHub Actions publishes the artifacts:

  • Snapshots, on each push to main or to a release branch (*.x), except for changes to the documentation only.
  • Releases, when a version tag such as v2.1.0 is pushed.