Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Add additional style rule to CONTRIBUTING.md

Browse Source
This commit is contained in:
Isaac Freund 2022-03-02 15:34:51 +01:00
parent 7b4c9c39ee
commit 238c39379d
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -41,6 +41,25 @@ strict limit. Note that inserting a trailing comma after the last parameter in
function calls, struct declarations, etc. will cause `zig fmt` to wrap those function calls, struct declarations, etc. will cause `zig fmt` to wrap those
lines. I highly recommend configuring your editor to run `zig fmt` on write. lines. I highly recommend configuring your editor to run `zig fmt` on write.
The single additional style rule is to avoid writing `if` statements and
similar across multiple lines without braces:
```zig
test {
// avoid this
if (foo)
bar();
// prefer this
if (foo) bar();
// or this
if (foo) {
bar();
}
}
```
On a higher level, prioritize simplicity of code over nearly everything else. On a higher level, prioritize simplicity of code over nearly everything else.
Performance is only a valid reason for code complexity if there are profiling Performance is only a valid reason for code complexity if there are profiling
results to back it up which demonstrate a significant benefit. results to back it up which demonstrate a significant benefit.