From 832afd4db1dc692963250b974e9d80c1733ab2a1 Mon Sep 17 00:00:00 2001 From: Leon Kiefer Date: Mon, 10 Aug 2020 19:49:36 +0200 Subject: [PATCH] added naming convention --- .github/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4afc1285..ed017994 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -32,3 +32,13 @@ Public methods must be documented with JavaDoc style comments. When introducing new methods you should think about if the method should be part of the public API or only used internally. Always use descriptive names for variables, only use acronyms if they are well known and frequently used. The coding style is defined using ClangFormat and automatically checked when you submit a Pull Request. + +### Naming + +Everything should be defined in the `CorsairLightingProtocol` namespace. +Use camel case for names. +Type names start with an upper case letter and variable, parameter and property names start with a lower case letter. + +Free function names should be unambiguous without the namespace. +So, don't use names such as `reset` or `init`. +Instead use `resetSomething` or `initSomethingElse`.