mirror of
https://github.com/neovim/neovim.git
synced 2024-09-17 20:58:20 -04:00
Issue #66 - Add lint tool and uncrustify config. Update contributing documentation on coding style.
This commit is contained in:
parent
3925d951a1
commit
6121d9b500
@ -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
|
||||
|
1578
uncrustify.cfg
Normal file
1578
uncrustify.cfg
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user