CONTRIBUTING: Fix some examples, escape underscores

This commit is contained in:
archshift 2014-05-20 15:08:27 -07:00
parent f3bf03caf8
commit 420b0ba31b

View file

@ -11,18 +11,18 @@ 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 internal
* Prefix "__" if ultra 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.
@ -96,7 +96,7 @@ void FooBar() {
break; break;
} }
std::vector std::string
you_can_declare, you_can_declare,
a_few, a_few,
variables, variables,