From: Joel Rosdahl <joel@rosdahl.net>
Date: Tue, 15 Jun 2021 19:02:29 +0000 (+0200)
Subject: Document the plan of changing naming conventions for namespaces
X-Git-Tag: v4.4~203
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3782849a9f897878afe79bb39e9fd44eda35a3ba;p=thirdparty%2Fccache.git

Document the plan of changing naming conventions for namespaces

Namespaces are from now on planned to be in snake_case instead of
UpperCamelCase. This is of course entirely due to cosmetical reasons,
but I feel that it maps better to the upcoming changes in directory
structure where I don’t want camel-case directory names.
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3a845c879..043f9141a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -61,10 +61,11 @@ fine.
 
 Please follow these conventions:
 
-* Use `UpperCamelCase` for types (e.g. classes and structs) and namespaces.
-* Use `UPPER_CASE` names for macros and (non-class )enum values.
-* Use `snake_case` for other names (functions, variables, enum class values,
-  etc.).
+* Use `UpperCamelCase` for types (e.g. classes and structs).
+* Use `UPPER_CASE` names for macros and (non-class) enum values.
+* Use `snake_case` for other names (namespaces, functions, variables, enum class
+  values, etc.). (Namespaces used to be in `UpperCamelCase`; transition is work
+  in progress.)
 * Use an `m_` prefix for non-public member variables.
 * Use a `g_` prefix for global mutable variables.
 * Use a `k_` prefix for global constants.