summaryrefslogtreecommitdiff
path: root/docs/Contributing/c-coding-style.md
diff options
context:
space:
mode:
authoromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-05-12 20:07:17 +1000
committeromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-05-12 20:07:17 +1000
commit02e84ee4d18e705e3362be1e327fdb6f1397a032 (patch)
treedb2d0d297df3049de7f88733b8d61034ec2c0fa1 /docs/Contributing/c-coding-style.md
parentd6d83264ff9446f19b8f611f8173812d783a20c2 (diff)
expand docs
Diffstat (limited to 'docs/Contributing/c-coding-style.md')
-rw-r--r--docs/Contributing/c-coding-style.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/Contributing/c-coding-style.md b/docs/Contributing/c-coding-style.md
new file mode 100644
index 0000000..4e268cc
--- /dev/null
+++ b/docs/Contributing/c-coding-style.md
@@ -0,0 +1,13 @@
+---
+title: C Coding Style
+---
+
+A lot of these should be forced onto you by `clang-format` and `clang-tidy` but for posterity here are
+a few of the styles that we stick to.
+
+* **Pointer next to type** - we use `type* variable` in function signatures and variable declarations e.g. `mat4* model`
+
+
+## Memory
+
+### Arena allocation