From 923b3e600bccd6fde21bc5f47739cba0258b4f27 Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Mon, 15 Jul 2019 04:05:00 +0530 Subject: [PATCH] Formatting changes --- CODING_GUIDELINES.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index 7f22be1..9647873 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -1,22 +1,22 @@ # Coding Guidelines -+ You can validate that your code complies with these guidelines by running `stuff/php-format.py validate`. -+ Tabs, no spaces. -+ End of line should should be Unix style (`\n`), not Windows style (`\r\n`). -+ Opening brackets goes in the same line as the last statement. - - if (condition) { - stuff; - } - -+ A space between keywords and parenthesis for: `if`, `else`, `while`, `switch`, `catch`, `function`. -+ Function calls have no space before the parentheses. -+ No spaces are left inside the parentheses. -+ A space after each comma, but without space before. -+ All binary operators must have one space before and one after. -+ There should not be more than one contiguous blank line. -+ There should be no empty comments. -+ You should not use block comments `/ * ... * /`, only line `// ...`. -+ Changes in functionality must be accompanied by their respective new / modified tests. -+ Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values. -+ Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...) +- You can validate that your code complies with these guidelines by running `stuff/php-format.py validate` +- Tabs, no spaces +- End of line should should be Unix style (`\n`), not Windows style (`\r\n`) +- Opening brackets goes in the same line as the last statement +``` + if (condition) { + stuff; + } +``` +- A space between keywords and parenthesis for: `if`, `else`, `while`, `switch`, `catch`, `function` +- Function calls have no space before the parentheses +- No spaces are left inside the parentheses +- A space after each comma, but without space before +- All binary operators must have one space before and one after +- There should not be more than one contiguous blank line +- There should be no empty comments +- You should not use block comments `/ * ... * /`, only line `// ...` +- Changes in functionality must be accompanied by their respective new / modified tests +- Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values +- Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...)