From d927c539b528c48e66b16ff0644a646e3dbaaabe Mon Sep 17 00:00:00 2001 From: QazCetelic Date: Sat, 23 Nov 2024 19:55:40 +0100 Subject: [PATCH] Update CONTRIBUTING.md conventions section Signed-off-by: QazCetelic --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 713c9ba7c..5965f4d8e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ All files are formatted with `clang-format` using the configuration in `.clang-format`. Ensure it is run on changed files before committing! -We have no tool for enforcing names but please follow the following conventions for C++: +Please also follow the project's conventions for C++: - Class and type names should be formatted as `PascalCase`: `MyClass`. - Private or protected class data members should be formatted as `camelCase` prefixed with `m_`: `m_myCounter`. @@ -16,6 +16,8 @@ We have no tool for enforcing names but please follow the following conventions - `const` global variables, macros, and enum constants should be formatted as `SCREAMING_SNAKE_CASE`: `LIGHT_GRAY`. - Avoid inventing acronyms or abbreviations especially for a name of multiple words - like `tp` for `texturePack`. +Most of these rules are included in the `.clang-tidy` file, so you can run `clang-tidy` to check for any violations. + Here is what these conventions with the formatting configuration look like: ```c++