summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRiku Isokoski <riksu9000@gmail.com>2021-10-22 12:42:06 +0300
committerRiku Isokoski <riksu9000@gmail.com>2021-10-22 12:42:06 +0300
commitf56bd4ce9de35edc0c9fb178c950f26c80d99b94 (patch)
treec85e2dcd49497a7df6589ed16e8082278b462841 /doc
parent89a29e9a0d6bb8ac257339a424bded30faa27afc (diff)
Update coding style
Diffstat (limited to 'doc')
-rw-r--r--doc/contribute.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/contribute.md b/doc/contribute.md
index 21746433..595a5996 100644
--- a/doc/contribute.md
+++ b/doc/contribute.md
@@ -94,3 +94,10 @@ If there are no preconfigured rules for your IDE, you can use one of the existin
- **Includes** :
- files from the project : `#include "relative/path/to/the/file.h"`
- external files and std : `#include <file.h>`
+ - Only use [primary spellings for operators and tokens](https://en.cppreference.com/w/cpp/language/operator_alternative)
+ - Use auto sparingly. Don't use auto for [fundamental/built-in types](https://en.cppreference.com/w/cpp/language/types) and [fixed width integer types](https://en.cppreference.com/w/cpp/types/integer), except when initializing with a cast to avoid duplicating the type name.
+ - Examples:
+ - `auto* app = static_cast<DisplayApp*>(instance);`
+ - `auto number = static_cast<uint8_t>(variable);`
+ - `uint8_t returnValue = MyFunction();`
+ - Use nullptr instead of NULL