aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2022-02-02 11:51:03 +0100
committerGitHub <[email protected]>2022-02-02 11:51:03 +0100
commitb23ab777f8a9e58a84ab00e198be2da2fc9acdc6 (patch)
treebbd36677c3d5e8447d43442d5f61041ca709c8dd
parentUpdate README.md (diff)
downloadzen-b23ab777f8a9e58a84ab00e198be2da2fc9acdc6.tar.xz
zen-b23ab777f8a9e58a84ab00e198be2da2fc9acdc6.zip
Update CODING.md
-rw-r--r--CODING.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/CODING.md b/CODING.md
index 3b37ca368..d94d9d665 100644
--- a/CODING.md
+++ b/CODING.md
@@ -1,5 +1,15 @@
# Naming Conventions
-* Classes/Structs - PascalCase
-* Functions - CamelCase
-* Class member variables - m_PascalCase
+The naming conventions for Zen are intended to resemble the Unreal Engine coding style, with some minor exceptions.
+
+* Classes/Structs - `PascalCase`
+* Functions - `PascalCase()`
+* Class member variables - `m_PascalCase`
+
+Those who are familiar with the UE coding standards will note that we do not require or encourage `F` prefixes on struct or classes, and we expect class members to have a `m_` member prefix.
+
+# Code formatting
+
+To ensure consistent formatting we rely on `clang-format` to automatically format source code. This leads to consistent formatting which should lead to less surprises and more straightforward merging.
+
+Formatting is triggered via `prepare_commit` which should be used ahead of commit. We do not currently reject commits which have not been formatted, but we probably should at some point in the future.