Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

50 lines (39 loc) · 2 KB

Contributing

Release Check List

Before making a public release, check the following items:

  1. Copyright headers shall be updated for all newly created or modified files.
  2. Review every change to Public API headers and make sure they are:
    1. Justified,
    2. Maintain backward compatibility.
  3. Make sure all tests run successfully.
  4. Run check-build-configurations.sh for x86 PC and Yocto aarch64.
  5. Validate Jenkins build

Script for Checking Build Configurations

Script file check-build-configurations.sh executes verbose cmake build for all combinations of input options:

  • BUILD_SHARED_LIBS
  • CMAKE_BUILD_TYPE
  • BUILD_TESTS (run make test if it is on)
  • WITH_DOXYGEN (runs make docs if it is on)
  • BUILD_GUI

This script assumes that doxygen and all other necessary packages are pre-installed on the build machine or in the SDK. A simple test project is compiled against libraries installed into a temporary directory.