From 02e84ee4d18e705e3362be1e327fdb6f1397a032 Mon Sep 17 00:00:00 2001
From: omniscient <17525998+omnisci3nce@users.noreply.github.com>
Date: Sun, 12 May 2024 20:07:17 +1000
Subject: expand docs

---
 docs/Contributing/naming.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 docs/Contributing/naming.md

(limited to 'docs/Contributing/naming.md')

diff --git a/docs/Contributing/naming.md b/docs/Contributing/naming.md
new file mode 100644
index 0000000..518c22e
--- /dev/null
+++ b/docs/Contributing/naming.md
@@ -0,0 +1,29 @@
+---
+title: Naming Conventions
+---
+
+#### 1. Prefer SOV function names
+
+Prefer SOV Subject Object Verb naming for functions.
+
+This makes it very easy to find the functions you want with autocomplete and maintain a consistent naming convention
+throughout the codebase.
+
+e.g.
+
+* `renderer_frame_begin`
+* `engine_tick_begin`
+* `texture_data_load`
+
+---
+
+#### 2. Long-running systems
+
+systems that run for the lifetime of the application or for a very long time should have:
+
+* `bool system_init(system_state* state)` a `init` function
+* `void system_shutdown(system_state* state)` and a `shutdown` function
+
+---
+
+#### 3. TODO
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2