RadioLib/CONTRIBUTING.md

Contributing to RadioLib

First of all, thank you very much for taking the time to contribute! All feedback and ideas are greatly appreciated. To keep this library organized, please follow these rules.

Issues

The following rules guide submission of new issues. These rules are in place mainly so that the issue author can get help as quickly as possible.

1. Questions are welcome, spam is not.
   Any issues without description will be considered spam and as such will be CLOSED and LOCKED immediately!
2. This repository has issue templates.
   To report bugs or suggest new features, use the provided issue templates. Use the default issue only if the templates do not fit your issue type.
3. Be as clear as possible when creating issues.
   Issues with generic titles (e.g. "not working", "lora", etc.) will be CLOSED until the title is fixed, since the title is supposed to categorize the issue. The same applies for issues with very little information and extensive grammatical or formatting errors that make it difficult to find out what is the actual issue.
4. Issues deserve some attention too.
   Issues that are left for 2 weeks without response by the original author when asked for further information will be closed due to inactivity. This is to keep track of important issues, the author is encouraged to reopen the issue at a later date.

Code style guidelines

I like pretty code! Or at least, I like consistent code style. When creating pull requests, please follow these style guidelines, they're in place to keep high code readability.

1. Bracket style
   This library uses the following style of bracket indentation (1TBS, or "javascript" style):

if (foo) {
  bar();
} else {
  baz();
}

2. Tabs
   Use 2 space characters for tabs.

3. Single-line comments
   Comments can be very useful - and they can become the bane of readability. Every single-line comment should start at new line, have one space between comment delimiter // and the start of the comment itself. The comment should also start with a lower-case letter.

// this function does something
foo("bar");

// here it does something else
foo(12345);

4. Split code into blocks
   It is very easy to write code that machine can read. It is much harder to write one that humans can read. That's why it's a great idea to split code into blocks - even if the block is just a single line!

// build a temporary buffer (first block)
uint8_t* data = new uint8_t[len + 1];
if(!data) {
  return(ERR_MEMORY_ALLOCATION_FAILED);
}

// read the received data (second block)
state = readData(data, len);

// add null terminator (third block)
data[len] = 0;

5. Doxygen
   If you're adding a new method, make sure to add appropriate Doxygen comments, so that the documentation is always complete.

6. Keywords
   This is an Arduino library, so it needs to comply with the Arduino library specification. To add a new keyword to the Arduino IDE syntax highlighting, add it to the keywords.txt file. Use true tabs in keywords.txt! No spaces there!

7. Dynamic memory
   Sometimes, RadioLib might be used in critical applications where dynamic memory allocation using new or malloc might cause issues. For such cases, RadioLib provides the option to compile using only static arrays. This means that every dynamically allocated array must have a sufficiently large static counterpart. Naturally, all dynamically allocated memory must be properly de-allocated using delete or free.

// build a temporary buffer
#ifdef RADIOLIB_STATIC_ONLY
  uint8_t data[RADIOLIB_STATIC_ARRAY_SIZE + 1];
#else
  uint8_t* data = new uint8_t[length + 1];
  if(!data) {
    return(ERR_MEMORY_ALLOCATION_FAILED);
  }
#endif

// read the received data
readData(data, length);

// deallocate temporary buffer
#ifndef RADIOLIB_STATIC_ONLY
  delete[] data;
#endif

8. God Mode
   During development, it can be useful to have access to the low level drivers, such as the SPI commands. These are incredibly powerful, since they will basically let user do anything he wants with the module, outside of the normal level of sanity checks. As such, they are normally protected using C++ access modifiers private or protected. God mode disables this protection, and so any newly implemented class must contain the appropriate macro check:

class Module {
  void publicMethod();

#ifndef RADIOLIB_GODMODE
  private:
#endif

  void privateMethod();
};

9. No Arduino Strings
   Arduino String class should never be used internally in the library. The only allowed occurence of Arduino String is in public API methods, and only at the top-most layer.