RF24Gateway - TCP/IP over RF24Network
v2.1.1
TMRh20 - Pushing the practical limits of RF24 modules
Loading...
Searching...
No Matches
CONTRIBUTING
These are the current requirements for getting your code included in RF24Gateway:
Try your best to follow the rest of the code, if you're unsure then the NASA C style can help as it's closest to the current style:
https://ntrs.nasa.gov/archive/nasa/casi.ntrs.nasa.gov/19950022400.pdf
Definetly follow
PEP-8
if it's Python code.
Follow the
Arduino IDE formatting style
for Arduino examples
Add
doxygen-compatible documentation
to any new functions you add, or update existing documentation if you change behaviour
CMake modules and CMakeLists.txt files should also have a uniform syntax.
Indentation is a mandatory 4 spaces (not a
\t
character).
Closing parenthesis for multi-line commands should have the same indentation as the line that opened the parenthesis.
For other useful CMake syntax convention, please see
CMake docs for developers
and
this useful best CMake practices article
. The qiBuild project has some
well-reasoned "Dos & Don'ts" guideline
, but beware that the nRF24 organization is not related to the qiBuild project in any way.
Generated on Sun Oct 6 2024 for RF24Gateway - TCP/IP over RF24Network by
1.11.0