Macintosh-Tools
/
dingusppc
mirror of https://github.com/dingusdev/dingusppc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

CONTRIBUTING: Use code blocks for code examples.

This commit is contained in:
Maxim Poliakovski 2020-03-05 11:53:28 +01:00 committed by GitHub
parent e31f7873f5
commit 78fc5c408b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -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())