From 2a058559d4f6076b6ef18e3ecb7da13b8f075dc7 Mon Sep 17 00:00:00 2001 From: Mattes D Date: Tue, 7 Jan 2014 16:43:47 +0100 Subject: [PATCH] Update CONTRIBUTING.md Added control statement braces and end-of-file blank lines. --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5aba6ac9e..83173a6af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,3 @@ - Code Stuff ---------- @@ -23,7 +22,9 @@ 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" - * Please leave the first line of all files blank, to get around an IDE bug. + * 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. + * Please leave the first line of all source files blank, to get around an IDE bug. + * Also leave the last line of all source files blank (GCC and GIT can complain otherwise) Copyright