From 02c28a1d8ad6cdf3238fc93202fa3aa284f55be2 Mon Sep 17 00:00:00 2001 From: David Moxey Date: Fri, 26 Feb 2016 20:10:28 +0000 Subject: [PATCH] More changes --- .clang-format | 1 - CONTRIBUTING.md | 11 ++++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.clang-format b/.clang-format index 13e4629de..95c28c051 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 c1bdc0273..4e65db7db 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` -- GitLab