Contributing

To have your patches merged:

1. conform to hawkey's coding style
2. all unit tests on your branch are passing
   1. preferably with no errors under basic Valgrind check
3. add unit tests for any new functionality /fixes your branch is providing
4. if you are extending or changing the lib's interface, reflect the changes in Python bindings
5. document your changes
6. make a pull request against the master branch
7. remember to describe all API changes in the request

Coding Style

C

• indent width is 4, tabs are used for multiples of eight, in Emacs:

  (setq c-basic-offset 4)
  (setq-default indent-tabs-mode t) 

Also see

• PEP 257 -- Docstring Conventions
• Sphinx Documentation Generator Documentation