libs/RFID.MFRC522
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md (#283)

Browse Source
This commit is contained in:
Rotzbua
2017-02-22 14:50:48 +01:00
committed by GitHub
parent f5f5788afe
commit 3f9d6705a4
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -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.