Contributing to Eclipse Cyclone DDS

We welcome all contributions to the project, including questions, examples, bug fixes, enhancements or improvements to the documentation, etc.

Tip

Contributing to Eclipse Cyclone DDS means donating your code to the Eclipse foundation. This means you need to sign the Eclipse Contributor Agreement using this form. It effectively means that what you are contributing is yours to give away and you are fine with everyone using and distributing it. However, don’t take legal advice from this getting started guide, read the terms linked above.

If you want to contribute code, it is helpful to know that build configurations for Azure DevOps Pipelines are present in the repositories. There is a test suite using CTest and CUnit that can be built locally.

The following sections explain how to do this for the different operating systems.

Linux and macOS

Set the CMake variable BUILD_TESTING to ON when configuring, e.g.:

cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
cmake --build .
ctest

This build requires CUnit. You can install this yourself, or you can choose to instead rely on the Conan packaging system that the CI build infrastructure also uses. In that case, install Conan in the build directory before running CMake:

conan install .. --build missing

Windows

Set the CMake variable BUILD_TESTING to ON when configuring, e.g.:

cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
cmake --build .
ctest

This build requires CUnit. You can install this yourself, or you can choose to instead rely on the Conan packaging system that the CI build infrastructure also uses. In that case, install Conan in the build directory before running CMake:

conan install .. --build missing

This automatically downloads and builds CUnit (and currently OpenSSL for transport security).

Note

Depending on the generator, you may also need to add switches to select the architecture and build type, e.g.:

conan install -s arch=x86_64 -s build_type=Debug ..