Contributions to the pmp-library are generally welcome. However, please keep in mind that we develop the library besides our daily jobs and therefore might not always find the time to quickly react to your requests and suggestions.
In case you run into trouble using the pmp-library, please check for existing issues. If your problem is not already reported file a new issue and also provide some piece of code and data to reproduce the behavior in question.
If you would like to contribute to the development of the pmp-library you should start by forking and creating a pull request. Make sure that your code follows the Coding Style guidelines. In case you want to contribute a new algorithm make sure the code is properly documented using Doxygen and is accompanied by a unit test, see below.
The pmp-library has a suite of unit tests that aims at making sure everything
works as expected. The unit tests are written
using Google Test and run during
continuous integration builds. See the also the tests sub-directory of the
repository. You can locally run the test suite from your build directory by
invoking the
make test
target. To obtain more detailed test output we recommend to invoke the Google Test runner directly:
cd tests
./gtest_runner
We track the overall code coverage rate of our unit tests using gcov, which is part of GCC. Generating the coverage report also requires the lcov package to be installed.
To check the code coverage locally run cmake in Debug mode with the
ENABLE_COVERAGE flag sett to true:
cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_COVERAGE=true ..
Rebuild and run the coverage target:
make && make coverage
This will run the test suite and collect the coverage data. A HTML report of the
results will be generated to coverage/index.html. We generally try to maintain
a high coverage rate of above 90%. Any code that you would like to contribute
should not decrease the coverage rate.