summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-02-01 00:48:28 +0100
committerskal <pascal.massimino@gmail.com>2026-02-01 00:48:28 +0100
commit03cd94817097e59a0809b222e0e1e74dd9a8ede7 (patch)
tree88348c96bcd96a3b61ad042def5e564bd3b874df
parent567e04d96159fa74cc6ea46e7e77d7f43ef32206 (diff)
update coding rules
-rw-r--r--CONTRIBUTING.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3c78f18..7ae2e52 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -142,10 +142,40 @@ prefer ```const T* name``` to ```const T *name```.
Don't use 'auto' as type, unless for complex iterators or very complex
types.
-### don't use trailing spaces
+### don't use trailing whitespaces
don't.
+### no missing \newline at the end of file
+
+make sure each file has a final \n newline.
+
+### c++ keyword indentation:
+
+The keyword 'public', 'protected', 'private' should be intended 1 character
+less than the methods.
+
+Example:
+```cpp
+ private:
+ int field_;
+```
+
+instead of:
+```cpp
+private:
+ int field_;
+```
+
+### vertical space
+
+keep the code compact vertically. That includes shader code, too.
+Use only one statement per line.
+
+### finally
+
+Make sure everything is reflected in clang-format.
+
## Development Protocols
### Adding a New Visual Effect