Skip to content

Commit

Permalink
CONTRIBUTING: Use code blocks for code examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
maximumspatium authored Mar 5, 2020
1 parent e31f787 commit 78fc5c4
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,14 @@ Code
* All code must be compatible with at least C++11.
* Minimize the amount of redundant code.
* Avoid using absolute paths for the headers.
* Code should maintain vertical alignment. An example of this is provided below:
* Code should maintain vertical alignment for better readability, for example:

> one_hundred = 100;
> one_thousand = 1000;
```C
one_hundred = 100;
one_thousand = 1000;
two_thousand = 2000;
```

** The following should be avoided:

> one_hundred = 100;
> one_thousand = 1000;
* CamelCase for class names, lowercase for variables, UPPERCASE for enumerations
* Avoid redundancy in namespaces (i.e. use ViaCuda::read() instead of ViaCuda::cuda_read())

Expand Down

0 comments on commit 78fc5c4

Please sign in to comment.