aboutsummaryrefslogtreecommitdiff
path: root/CODING.md
blob: d94d9d66537184d77d0e84bc34d84e1bc7b4f4ba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Naming Conventions

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.