eitan.c/suyu
1
0
Fork 0
forked from suyu/suyu
Code Pull requests Activity

Update CONTRIBUTING.md

Browse source 
- removed variable naming starting with "_"
- removed "Always break, even after a return" from case statements
This commit is contained in:
bunnei 2014-06-01 15:31:36 -04:00 committed by bunnei
parent 0a48e97c36
commit 77c0f9868e
1 changed files with 7 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md
View file

@ -1,5 +1,4 @@
# Contributing # Contributing
Citra is a brand new project, so we have a great opportunity to keep things clean and well organized early on. As such, coding style is very important when making commits. They aren't very strict rules since we want to be flexible and we understand that under certain circumstances some of them can be counterproductive. Just try to follow as many of them as possible: Citra is a brand new project, so we have a great opportunity to keep things clean and well organized early on. As such, coding style is very important when making commits. They aren't very strict rules since we want to be flexible and we understand that under certain circumstances some of them can be counterproductive. Just try to follow as many of them as possible:
### General Rules ### General Rules
@ -11,18 +10,16 @@ Citra is a brand new project, so we have a great opportunity to keep things clea
### Naming Rules ### Naming Rules
* Functions * Functions
* CamelCase, `_` may also be used for clarity (e.g. `ARM_InitCore`) * CamelCase, "_" may also be used for clarity (e.g. ARM_InitCore)
* Variables * Variables
* lower\_case\_underscored * lower_case_underscored
* Prefix `g_` if global * Prefix "g_" if global
* Prefix `_` if internal
* Prefix `__` if ultra internal
* Classes * Classes
* CamelCase, `_` may also be used for clarity (e.g. `OGL_VideoInterface`) * CamelCase, "_" may also be used for clarity (e.g. OGL_VideoInterface)
* Files/Folders * Files/Folders
* lower\_case\_underscored * lower_case_underscored
* Namespaces * Namespaces
* CamelCase, `_` may also be used for clarity (e.g. `ARM_InitCore`) * CamelCase, "_" may also be used for clarity (e.g. ARM_InitCore)
### Indentation/Whitespace Style ### Indentation/Whitespace Style
Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spaces instead. Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spaces instead.
@ -88,15 +85,13 @@ void FooBar() {
case 3: case 3:
DoSomething(var); DoSomething(var);
return; return;
// Always break, even after a return
break;
default: default:
// Yes, even break for the last case // Yes, even break for the last case
break; break;
} }
std::string std::vector
you_can_declare, you_can_declare,
a_few, a_few,
variables, variables,