kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add the neovim style guide to the contributing guide.

Browse Source
This commit is contained in:
Chris Watkins 2014-04-23 22:47:00 -07:00 committed by Thiago de Arruda
parent b951cf5bfc
commit c3fb8240bc
1 changed files with 2 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -40,18 +40,11 @@ someone else doesn't duplicate the work.
### Coding style ### Coding style
All code changes should follow the [Google C++ style guide](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) All code changes should follow the [neovim style guide](http://neovim.org/development-wiki/style-guide/style-guide.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 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) [`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 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 `clint.py` ignore certain special cases, put `// NOLINT` at the end of the
line. line.