Contributing

Jump to bottom Edit New page

Javier Pollak edited this page May 7, 2021 · 7 revisions

Style guide

In general, you should use uncrustify with the uncrustify.ini file from the repo. There are also automatic checks for your PR.

To run uncrustify on all project files:

$ git ls-files | grep "hpp$\|cpp$" | xargs uncrustify -c uncrustify.ini --no-backup

Names

Class, method and variable names are all in snake_case. Class names should end in _t.

File names are all lowercase, with - as word separator. Headers end in .hpp. So, a header could be called this-is-example-header.hpp.

Headers

Use #pragma once instead of #ifdef.