From 2c2aff202e3a8feecc49eb00d98cd7ab0fc0448e Mon Sep 17 00:00:00 2001 From: Jake Bolewski Date: Mon, 19 Jan 2015 21:01:39 -0500 Subject: [PATCH] Update CONTRIBUTING.md to add line length limit Prompted by encountering some 250+ character lines in the linear algebra library Also add naming conventions for modules, types, and methods. [ci skip] --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f52514a3d59e..5193cda28f5c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,14 +95,17 @@ Build as usual, and do `make clean testall` to test your contribution. If your c ##### General Formatting Guidelines For Julia code contributions - - 4 space indent + - 4 spaces per indentation level, no tabs - use whitespace to make the code more readable - - no whitespace at the end of a line + - no whitespace at the end of a line (trailing whitespace) - comments are good, especially when they explain the algorithm + - try to adhere to a 92 character line length limit + - use upper camel case convention for modules, type names + - use lower case with underscores for method names ##### General Formatting Guidelines For C code contributions - - 4 space indent + - 4 spaces per indentation level, no tabs - space between if and ( (if (x) ...) - newline before opening { in function definitions - f(void) for 0-argument function declarations