diff options
author | Howaner <franzi.moos@googlemail.com> | 2014-04-03 22:03:18 +0200 |
---|---|---|
committer | Howaner <franzi.moos@googlemail.com> | 2014-04-03 22:03:18 +0200 |
commit | 32d054e8fdad1d486fd4edbb542daa3262220e5f (patch) | |
tree | 1094c471768b71e8cac1277c2fbea5a5d9f2caf9 /CONTRIBUTING.md | |
parent | Remove old function (diff) | |
parent | APIDump: Added angular specifics. (diff) | |
download | cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.gz cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.bz2 cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.lz cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.xz cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.tar.zst cuberite-32d054e8fdad1d486fd4edbb542daa3262220e5f.zip |
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0a332f30..0c36be8b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ Code Stuff ---------- - * We use C++03 + * We use C++03 with some C++11 extensions (ask if you think that something would be useful) * Use the provided wrappers for OS stuff: - Threading is done by inheriting from `cIsThread`, thread synchronization through `cCriticalSection`, `cSemaphore` and `cEvent`, file access and filesystem operations through the `cFile` class, high-precision timers through `cTimer`, high-precision sleep through `cSleep` * No magic numbers, use named constants: @@ -22,8 +22,10 @@ Code Stuff - This helps prevent mistakes such as `if (a & 1 == 0)` * White space is free, so use it freely - "freely" as in "plentifully", not "arbitrarily" + * All `case` statements inside a `switch` need an extra indent. * Each and every control statement deserves its braces. This helps maintainability later on when the file is edited, lines added or removed - the control logic doesn't break so easily. - The only exception: a `switch` statement with all `case` statements being a single short statement is allowed to use the short brace-less form. + - These two rules really mean that indent is governed by braces * Add an empty last line in all source files (GCC and GIT can complain otherwise) * Use doxy-comments for functions in the header file, format as `/** Description */` * Use spaces after the comment markers: `// Comment` instead of `//Comment` |