Skip to content

Commit

Permalink
Update CONTRIBUTING.md to add line length limit
Browse files Browse the repository at this point in the history
Prompted by encountering some 250+ character lines in the linear algebra library

Also add naming conventions for modules, types, and methods.

[ci skip]
  • Loading branch information
jakebolewski committed Jan 20, 2015
1 parent 6bc53e6 commit 2c2aff2
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

2 comments on commit 2c2aff2

@PallHaraldsson
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like I remember 80 character line limit discussed, wander where 92 comes from..

@jakebolewski
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let your mind wander some more, you might find no answer.

Please sign in to comment.