From 3f9d6705a4999b0484cc95fd4f28464811f8942d Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Wed, 22 Feb 2017 14:50:48 +0100 Subject: [PATCH] Create CONTRIBUTING.md (#283) --- .github/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..e7c13ba --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,10 @@ +Code style +---------- + +1. Please use ``fixed integers``, see `stdint.h`_. Why? This library is compatible to different boards which use different architectures (16bit vs 32bit). So unfixed ``int`` has different sizes on different environments and may cause unpredictable behaviour. + +2. If possible: use advantages of `c++11`, e.g. `constexpr`. + +3. Use tab in source files. Space in examples. + +4. Add documentation to **every** new function or parameter. Add documentation to most steps in your source code.