Contributing

• Contributing
  • Setup
    • Using a dev container environment
    • Bring your own toolbox
  • Build
  • Test

Setup

Using a dev container environment

OpenDAL provides a pre-configured dev container that could be used in GitHub Codespaces, VSCode, JetBrains, JupyterLab. Please pick up your favourite runtime environment.

The fastest way is:

Bring your own toolbox

To build OpenDAL D binding locally, you need:

• dmd/ldc/gdc

Build

First, build the C bindings:

dub build -b release

Note:

• dub build adds the header file opendal.h under ../c/include
• The library is under ../../target/debug or ../../target/release after building.

Test

To build and run the tests.

$ dub test
  Generating test runner configuration 'opendal-test-unittest' for 'unittest' (library).
    Starting Performing "unittest" build using /usr/bin/ldc2 for x86_64.
    Building opendal ~master: building configuration [opendal-test-unittest]
   Pre-build Running commands
    Finished `release` profile [optimized] target(s) in 0.08s
Cargo build completed successfully
     Linking opendal-test-unittest
     Running opendal-test-unittest 
Basic Operator creation and write test passed
1 modules passed unittests