How to contribute

Testing

Our unit tests for the features are developed based on the Google-test framework, and are automatically sent to Coveralls.io for coverage analysis.

Please send a GitHub Pull Request with a clear list of what you have done.

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit

A paragraph describing what changed and its impact."

We follow the Google C++ Guilde Style, and use Clang-format for consistent code.

Here are some of the most obvious conventions:

We indent using two spaces
We use C-style Doxygen labels.
We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), and around hash arrows.

Thanks!