fixed formatting on contributing page

This commit is contained in:
itsmattkc
2020-05-01 17:03:06 +10:00
parent e67dabf1ff
commit b39403a4e9
+7 -7
View File
@@ -7,13 +7,13 @@ Thank you for your interest in contributing to Olive! In order to keep the code
When contributing to Olive, it's recommended to use the following rules:
* The code style generally follows the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) including, but not limited to:
** Indentation is 2 spaces wide, spaces only (no tabs)
** `lowercase_underscored_variable_names`
** `lowercase_underscored_functions()` or `SentenceCaseFunctions()`
** `class SentenceCaseClassesAndStructs {}`
** `kSentenceCaseConstants` prepended with a lowercase `k`
** `UPPERCASE_UNDERSCORED_MACROS` for variables or same style as functions for macro functions
** `class_member_variables_` end with a `_`
* Indentation is 2 spaces wide, spaces only (no tabs)
* `lowercase_underscored_variable_names`
* `lowercase_underscored_functions()` or `SentenceCaseFunctions()`
* `class SentenceCaseClassesAndStructs {}`
* `kSentenceCaseConstants` prepended with a lowercase `k`
* `UPPERCASE_UNDERSCORED_MACROS` for variables or same style as functions for macro functions
* `class_member_variables_` end with a `_`
* 100 column limit (where it doesn't impair readability)
* Unix line endings (only LF no CRLF)
* Javadoc documentation where appropriate