Developer guidelines

If you want to contribute to the library, please follow these guidelines to ease the integration

How to contribute

• Use your github account to fork the hauspie/rflpc repository and push your contribution to your fork. Then, send me a pull-request for integration to the master branch
• Always do your development based on the master branch, except if you want to submit me a hotfix of a released version. In the later case, base your work on the last released tag, I will take care of integrating the hotfix in the master branch.
• Try to do some extensive tests on your code, and, if you can, a bit of code review (which I'll do with you anyway before integrating your patch)

Coding conventions

• All symbol names are in lower case, prefixed by rflpc_ and a term describing the category of the symbol/function. For example:
  • rflpc_eth_xxx for an ethernet driver
  • rflpc_spi_xxx for SPI drivers
  • ...
• Type names uses the same prefix guidelines and must finish by a _t
• If possible, prefer static inline functions to macros
• All new feature must be able to be enabled/disabled using the config system.
  • you should put your code in a #ifdef RFLPC_CONFIG_ENABLE_xxx ... #endif block. The chosen name must be explicit
• Notable exception to the prefix rule is for function that implements some libc well known functions (printf, memcpy, memset...)