Skip to content

Commit 2c2aff2

Browse files
committed
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]
1 parent 6bc53e6 commit 2c2aff2

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

CONTRIBUTING.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,17 @@ Build as usual, and do `make clean testall` to test your contribution. If your c
9595

9696
##### General Formatting Guidelines For Julia code contributions
9797

98-
- 4 space indent
98+
- 4 spaces per indentation level, no tabs
9999
- use whitespace to make the code more readable
100-
- no whitespace at the end of a line
100+
- no whitespace at the end of a line (trailing whitespace)
101101
- comments are good, especially when they explain the algorithm
102+
- try to adhere to a 92 character line length limit
103+
- use upper camel case convention for modules, type names
104+
- use lower case with underscores for method names
102105

103106
##### General Formatting Guidelines For C code contributions
104107

105-
- 4 space indent
108+
- 4 spaces per indentation level, no tabs
106109
- space between if and ( (if (x) ...)
107110
- newline before opening { in function definitions
108111
- f(void) for 0-argument function declarations

0 commit comments

Comments
 (0)