diff options
| author | Chris Watkins <chris.watkins88@gmail.com> | 2014-04-23 22:47:00 -0700 |
|---|---|---|
| committer | Thiago de Arruda <tpadilha84@gmail.com> | 2014-04-24 10:50:50 -0300 |
| commit | c3fb8240bc03a34382c1cbcde21445e874ce6baa (patch) | |
| tree | 82029feab424f2dc3fc47a737e8b681e9ce76622 | |
| parent | b951cf5bfc5eac07cf5d60c29c0db7ee1f2818cc (diff) | |
| download | rneovim-c3fb8240bc03a34382c1cbcde21445e874ce6baa.tar.gz rneovim-c3fb8240bc03a34382c1cbcde21445e874ce6baa.tar.bz2 rneovim-c3fb8240bc03a34382c1cbcde21445e874ce6baa.zip | |
Add the neovim style guide to the contributing guide.
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 2 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ccf89ca07e..c7987e2000 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,18 +40,11 @@ someone else doesn't duplicate the work. ### Coding style -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. +All code changes should follow the [neovim style guide](http://neovim.org/development-wiki/style-guide/style-guide.xml). 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 +script modified with the neovim 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. |