Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 634 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (12 loc) · 634 Bytes

Contributing guidelines

Code contributions welcomed!
The guideline is simple:

  1. Conform to the license (MIT)
  2. No dependencies (C library for C is ok, POSIX is OK, STL for C++ is ok)
  3. Document your code and test the doxygen output
  4. C++ code should be wrappers only - the actual code must be written in C
  5. C++ code should be C++11
  6. C++ code must be inline so it does not go into the shared object
  7. If possible, add an example (C or C++) in the examples folder, make sure to update the makefile for it
  8. Take a look at the code and try to match the coding conventions

That's it, thanks for contributing!