Skip to content

Commit

Permalink
added naming convention
Browse files Browse the repository at this point in the history
  • Loading branch information
Legion2 committed Aug 10, 2020
1 parent bb45884 commit 832afd4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit 832afd4

Please sign in to comment.