Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Rotzbua committed Oct 27, 2018
1 parent b4fd278 commit 91eca6e
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
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.
1. Please use `fixed integers`, see `stdint.h`_. Why? This library is compatible to different boards which use different architectures (8bit 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.
3. Add documentation to **every** new function or parameter. Add documentation to most steps in your source code.

0 comments on commit 91eca6e

Please sign in to comment.