From 4c8c6e543ecef1b447d27b7e72739317e670d039 Mon Sep 17 00:00:00 2001 From: Trial97 Date: Fri, 8 Nov 2024 00:18:12 +0200 Subject: [PATCH] fix contrributing Signed-off-by: Trial97 --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31881270a..713c9ba7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,10 +5,11 @@ 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++: + - 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`. - Private or protected `static` class data members should be formatted as `camelCase` prefixed with `s_`: `s_instance`. -- Public class data members should be formatted as `camelCase` without the prefix: `dateOfBirth`. +- Public class data members should be formatted as `camelCase` without the prefix: `dateOfBirth`. - Public, private or protected `static const` class data members should be formatted as `SCREAMING_SNAKE_CASE`: `MAX_VALUE`. - Class function members should be formatted as `camelCase` without a prefix: `incrementCounter`. - Global functions and non-`const` global variables should be formatted as `camelCase` without a prefix: `globalData`.