diff --git a/.clang-format b/.clang-format index 13e4629def77b5fa3a25d2490a3ee27861f815f9..95c28c05183229f8750cb534d1d561fe12079c9c 100644 --- a/.clang-format +++ b/.clang-format @@ -1,6 +1,5 @@ BasedOnStyle: LLVM AlignAfterOpenBracket: true -AlignConsecutiveAssignments: true IndentWidth: 4 BreakBeforeBraces: Allman AllowShortBlocksOnASingleLine: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1bdc027347bec8b9be3a5c4c7f35f3b624bf484..4e65db7db711ba155d4467332e9801d40fc4c32a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -123,7 +123,8 @@ below this would be fantastic. } ``` - **Don't use preprocessor directives and macros unless there is no viable - alternative.** The exception to this is header guards inside your `.h` files. + alternative.** The exception to this is header guards inside your `.h` files, + which you should be sure to include in any headers you contribute. - Use one `.cpp` and `.h` file per C++ class, and try to keep `inline` header code to a minimum (unless performance is a major factor). - Put spaces around binary operators and constants. @@ -131,10 +132,10 @@ below this would be fantastic. example above). ### Variables and naming -- Please use sensible names! -- Use camelCase to define your variable and function names, - e.g. `myAwesomeVariable`. Any `typedef`s, function, `class` and `struct` names - should begin with capital letters, variable names should be lower case. +- Please use sensible names and use camelCase as a broad naming convention. + - Variables should start with a lowercase letter, e.g. `myAwesomeVariable`. + - Function, `class`, `struct` and `typedef` names should begin with capital + letters, e.g. `MyAwesomeFunction`. - Inside classes, member variables should be prefixed with `m_`, e.g. `m_myAwesomeVariable`. - Global constants used throughout the library should be prefixed with `k`