Skip to content

Commit

Permalink
fix contrributing
Browse files Browse the repository at this point in the history
Signed-off-by: Trial97 <[email protected]>
  • Loading branch information
Trial97 committed Nov 7, 2024
1 parent 1d9508c commit 4c8c6e5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 4c8c6e5

Please sign in to comment.