Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.36 KB

DEVELOPMENT.md

File metadata and controls

35 lines (25 loc) · 1.36 KB

Development guide

Setting up the workspace

Instructions for setting up development environment. First, enable testing in cmake by passing -DBUILD_TESTING and use ctest to run the test suite.

mkdir build
cd build
cmake -DBUILD_TESTING=ON ..
cmake --build .
ctest .

Contributing

The framework used to support testing is GoogleTest 1.11+.

Bug fix patches

To submit bug fixes, please add a test showing the failing behavior that is being fixed to prevent its reintroduction in the future.

New features

For contributing new features we recommend creating a Pull Request with a .md doc in the feature_rfc directory. There, we can have design discussions before investing time in the implementation of it.

Once a feature is designed, Pull Requests with the new feature implementation can be submitted. Any new feature submission requires updates to the documentation to include the new feature, unit tests, modifications to the CMakeLists building scripts, and usage examples. If you need help with any of these components, please feel free to open a Pull Request with the partial contribution and explain on it what is missing so others can contribute to complete the PR submission before merging to main. For features that are contributed by multiple contributors, feature-branches can be requested and created.