Jan/WLED_MM_Infinity
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
small update for coding style
This commit is contained in:
Frank
2023-08-24 17:56:37 +02:00
committed by GitHub
parent 9e4f040d41
commit f09fd7b50e
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@@ -23,6 +23,11 @@ if (a == b) {
} }
``` ```
```cpp
if (a == b) doStuff(a);
```
less readable, but acceptable in some cases:
```cpp ```cpp
if (a == b) if (a == b)
{ {
@@ -30,9 +35,6 @@ if (a == b)
} }
``` ```
```cpp
if (a == b) doStuff(a);
```
There should always be a space between a keyword and its condition and between the condition and brace. There should always be a space between a keyword and its condition and between the condition and brace.
Within the condition, no space should be between the paranthesis and variables. Within the condition, no space should be between the paranthesis and variables.
@@ -75,4 +77,4 @@ Good:
There is no set character limit for a comment within a line, There is no set character limit for a comment within a line,
though as a rule of thumb you should wrap your comment if it exceeds the width of your editor window. though as a rule of thumb you should wrap your comment if it exceeds the width of your editor window.
Inline comments are OK if they describe that line only and are not exceedingly wide. Inline comments are OK if they describe that line only and are not exceedingly wide.