kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CONTRIBUTING: Add a section on coding style 

Document that we now define our coding style with `clang-format`.
This commit is contained in:
Brad King 2016-05-16 10:53:59 -04:00
parent bf451d9ff9
commit 6a13f43f30
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.rst
View File

@ -23,6 +23,16 @@ Please base all new work on the ``master`` branch. Then use
``git format-patch`` to produce patches suitable to post to ``git format-patch`` to produce patches suitable to post to
the mailing list. the mailing list.
Code Style
==========
We use `clang-format`_ to define our style for C++ code in the CMake source
tree. See the `.clang-format`_ configuration file for our style settings.
Use ``clang-format`` version 3.8 or higher to format source files.
.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
.. _`.clang-format`: .clang-format
License License
======= =======