diff options
author | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-05-12 20:07:17 +1000 |
---|---|---|
committer | omniscient <17525998+omnisci3nce@users.noreply.github.com> | 2024-05-12 20:07:17 +1000 |
commit | 02e84ee4d18e705e3362be1e327fdb6f1397a032 (patch) | |
tree | db2d0d297df3049de7f88733b8d61034ec2c0fa1 /docs/Contributing/naming.md | |
parent | d6d83264ff9446f19b8f611f8173812d783a20c2 (diff) |
expand docs
Diffstat (limited to 'docs/Contributing/naming.md')
-rw-r--r-- | docs/Contributing/naming.md | 29 |
1 files changed, 29 insertions, 0 deletions
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 |