diff options
| author | Stefan Boberg <[email protected]> | 2023-05-02 10:01:47 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-05-02 10:01:47 +0200 |
| commit | 075d17f8ada47e990fe94606c3d21df409223465 (patch) | |
| tree | e50549b766a2f3c354798a54ff73404217b4c9af /CODING.md | |
| parent | fix: bundle shouldn't append content zip to zen (diff) | |
| download | zen-075d17f8ada47e990fe94606c3d21df409223465.tar.xz zen-075d17f8ada47e990fe94606c3d21df409223465.zip | |
moved source directories into `/src` (#264)
* moved source directories into `/src`
* updated bundle.lua for new `src` path
* moved some docs, icon
* removed old test trees
Diffstat (limited to 'CODING.md')
| -rw-r--r-- | CODING.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/CODING.md b/CODING.md deleted file mode 100644 index c4be7906c..000000000 --- a/CODING.md +++ /dev/null @@ -1,24 +0,0 @@ -# Naming Conventions - -The naming conventions for Zen are intended to remain close to the Unreal Engine coding style, with some minor exceptions wrt prefixes. - -* Classes/Structs - `PascalCase` -* Functions - `PascalCase()` -* Class member variables - `m_PascalCase` -* Global variables - `g_PascalCase` -* Static variables - `s_PascalCase` -* Thread local variables - `t_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 fewer surprises and more straightforward merging. - -Formatting is ensured by using [pre-commit](https://pre-commit.com/) - -- [Ensure you have a Python install](https://www.python.org/downloads/) and that Python has been added to the PATH environment variable -- [Install pre-commit](https://pre-commit.com/#installation) so it is available in PATH -- Run pre-commit manually on staged files `pre-commit run` -- Run pre-commit manually on all files `pre-commit run --all-files` -- Install git commit hooks `pre-commit install`, which will automatically run before every commit. |