From 238c39379d461a97619241e0daf0a437eb60bbc3 Mon Sep 17 00:00:00 2001
From: Isaac Freund <mail@isaacfreund.com>
Date: Wed, 2 Mar 2022 15:34:51 +0100
Subject: [PATCH] doc: Add additional style rule to CONTRIBUTING.md

---
 CONTRIBUTING.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b296807..acf6f08 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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
 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.
 Performance is only a valid reason for code complexity if there are profiling
 results to back it up which demonstrate a significant benefit.