diff options
| author | Brendan Le Foll <brendan.le.foll@intel.com> | 2015-06-01 15:17:05 +0100 |
|---|---|---|
| committer | Brendan Le Foll <brendan.le.foll@intel.com> | 2015-06-01 15:17:05 +0100 |
| commit | bca2bce32386bb6db1d5bb31b4e0b6827424b3d4 (patch) | |
| tree | 8b59b554dec1f17217da10580a5a278e62f38090 /docs/contributing.md | |
| parent | d6b33a9cbfce7c8d3f83cc9eadfc961eb0c259cd (diff) | |
contributing.md: add notes on cmakelist coding style
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index e69b5b0..f4bf41a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -26,6 +26,21 @@ Basic rules - Try to stick to the established coding style regardless of your personal feeling for it! Use clang-format (3.6+ required) +Coding Style +------------ + +Coding style for all code is defined by clang-format, have a look at it. Avoid +styling fixes as they make history difficult to read. Javascript & Java can +also be parsed through the clang-format, it complains but seems to do an ok +job. Few exceptions to coding styles: +- All python code is indented by 2 spaces +- CmakeLists files are 2 space indented and a space is required before all + brackets so endif () and if () and command (). Also use lowercase for + everything but variables. Cmake is case insensitive but this isn't the wild + wild west ;-) + +Use common sense and don't be afraid to challenge something if it doesn't make sense! + Code signing ------------ |