summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSafwat Halaby <SafwatHalaby@users.noreply.github.com>2015-05-09 11:35:28 +0200
committerSafwat Halaby <SafwatHalaby@users.noreply.github.com>2015-05-09 11:35:28 +0200
commita30fb91a13f7f087ac8f585747aefd0d8e279c29 (patch)
tree062fa9f5d860ad8a21cd890a7582d32e29b7647a
parentMerge pull request #1973 from Tri125/QuartzStack (diff)
parentUpdate Contributing.MD (diff)
downloadcuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.tar
cuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.tar.gz
cuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.tar.bz2
cuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.tar.lz
cuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.tar.xz
cuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.tar.zst
cuberite-a30fb91a13f7f087ac8f585747aefd0d8e279c29.zip
Diffstat (limited to '')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 82f09b6bf..4e57e6efb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,8 +8,8 @@ Here are the conventions:
* We use the subset of C++11 supported by MSVC 2013 (ask if you think that something would be useful)
* All new public functions in all classes need documenting comments on what they do and what behavior they follow, use doxy-comments formatted as `/** Description */`. Do not use asterisks on additional lines in multi-line comments.
* Use spaces after the comment markers: `// Comment` instead of `//Comment`. A comment must be prefixed with two spaces if it's on the same line with code:
- - `SomeFunction() // Note the two spaces prefixed to me and the space after the slashes.`
- * All variable names and function names use CamelCase style.
+ - `SomeFunction()<Space><Space>//<Space>Note the two spaces prefixed to me and the space after the slashes.`
+ * All variable names and function names use CamelCase style, with the exception of single letter variables.
- `ThisIsAProperFunction()` `This_is_bad()` `this_is_bad` `GoodVariableName` `badVariableName`.
* All member variables start with `m_`, all function parameters start with `a_`, all class names start with `c`.
- `class cMonster { int m_Health; int DecreaseHealth(int a_Amount); }`