diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94e120aca2..ccf89ca07e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,7 +40,22 @@ someone else doesn't duplicate the work. ### Coding style -- Use the 'hybrid' style described [here](https://gist.github.com/davidzchen/9188090). Get a `.editorconfig` for it [here](https://gist.github.com/ashleyh/9292108) -- Don't abuse the pre-processor. -- Don't mix platform-specific stuff into the main code. -- TODO: commit messages? +All code changes should follow the [Google C++ style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) +with the following exceptions: + + * Function names should be `lower_case` separated by underscores. + * Struct and enum names that are not typedef-ed are `struct lower_case` and + `enum lower_case`. + * The opening brace for function declarations should appear on the next line. + * All control structures must always use braces. + +Please run `clint.py` to detect style errors. `clint.py` is Google's +[`cpplint.py`](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#cpplint) +script modified with the above style guidelines. It is not perfect and may +have false positives and negatives, but is still a valuable tool. To have +`clint.py` ignore certain special cases, put `// NOLINT` at the end of the +line. + +### Commit messages + +TODO |