]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
Mention the “always use curly braces” convention in CONTRIBUTING.md
authorJoel Rosdahl <joel@rosdahl.net>
Sun, 26 Apr 2020 18:59:44 +0000 (20:59 +0200)
committerJoel Rosdahl <joel@rosdahl.net>
Sun, 26 Apr 2020 18:59:44 +0000 (20:59 +0200)
CONTRIBUTING.md

index d9748a4e7347f4cc9957db2ad2d1a5850c79f78a..08d5209e7fc9e012b22557d3a1fb7be92397ddde 100644 (file)
@@ -58,12 +58,14 @@ little by little.
 
 Source code formatting is defined by `.clang-format` in the root directory.
 It's based on [LLVM's code formatting
-style](https://llvm.org/docs/CodingStandards.html) with some deviations. You
+style](https://llvm.org/docs/CodingStandards.html) with some exceptions. You
 can install the [clang-format](https://clang.llvm.org/docs/ClangFormat.html)
 6.0 or newer and run `make format` to fix up the source code formatting.
 
-Regarding naming:
+Please follow these conventions:
 
+* Always use curly braces around if/for/while/do bodies, even if they only
+  contain one statement.
 * Use `UpperCamelCase` for types (e.g. classes and structs) and namespaces.
 * Use `UPPER_CASE` names for macros.
 * Use `snake_case` for other names (functions, variables, enum values, etc.).