Thank you for your interest in contributing! This project provides Java bindings for OpenData systems.
This project contains:
log/src- Java interface classes and Panama FFM bindings (dev.opendatapackage)common/src- Shared utilities, configuration records, and exceptions
Before contributing, read the README.
Open an issue with:
- Steps to reproduce the issue
- Expected vs actual behavior
- Your environment (OS, Java version, Rust version)
- Relevant logs or error messages
Open an issue describing:
- The feature and the problem it solves
- Any implementation ideas (optional)
- For significant changes, open an issue first to discuss your approach
- Fork the repository and create a branch for your work
- Write code and tests
- Submit a pull request
- Rust stable toolchain (rustup)
- Java 24+ (SDKMAN recommended)
- Git
- Local clone of opendata as sibling directory
your-workspace/
├── opendata/ # Clone of opendata repo
└── opendata-java/ # This project
# Build the native C library
cd ../opendata/log/c
cargo build --release
# Build Java modules (generates FFM bindings via jextract)
cd ../../../opendata-java
./gradlew build- Follow standard Java conventions
- Use 4-space indentation
- Prefer records for immutable data classes
- Package:
dev.opendata
- Write clear, self-documenting code
- Add comments for complex logic, especially FFM boundary handling
- Prefer returning errors over panicking in native code
Include tests for new functionality.
@Test
void shouldAppendAndReadEntry() {
// given
byte[] key = "test-key".getBytes();
byte[] value = "test-value".getBytes();
// when
AppendResult result = log.tryAppend(key, value);
// then
assertThat(result.sequence()).isGreaterThan(0);
}# Build C library first
cd ../opendata/log/c && cargo build --release
# Java tests (requires C library built)
cd ../../../opendata-java
./gradlew test- Ensure your code builds and tests pass
- Update documentation if needed
- Add a clear description of changes
- Reference any related issues
By contributing, you agree that your contributions will be licensed under the MIT License.