From 788c7a3e26d7c0ede81a5737dab55d680b0ae11b Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@kit.edu>
Date: Mon, 15 Apr 2019 17:37:12 +0200
Subject: [PATCH] Update CONTRIBUTING.md
---
CONTRIBUTING.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b0371899d..9a153d630 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -54,7 +54,9 @@ While `clang-format` does the structural formatting, we still need to agree on n
- enums should be "enum class"
- Function parameter names start with "v"
- types in template definitions start with "T"
- - Normal variable names in code start non-capital, and they cannot start with a "prefixed" v, T, f, fg, or g character
+ - Normal variable names in code start non-capital. To avoid confusion with these special identifiers
+ described above in case an identifier starts with `v`, `T`, `f`, `fg`, or `g`, this prefix may not be
+ followed by a capital letter. i.e. `funkyVariable` is allowed while `vLooksLikeArgument` is not.
- We use namespaces to avoid clashes and to structure code
- *Everything* is part of the corsika namespace
--
GitLab