summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-05-16 14:53:59 (GMT)
committerBrad King <brad.king@kitware.com>2016-05-16 20:04:46 (GMT)
commit6a13f43f309dd3484c3339730d141c89ecb27101 (patch)
tree3e5ea77fd3ebeb0dae57dedbed9d6522c89cea51 /CONTRIBUTING.rst
parentbf451d9ff92fb8240dbb0e7af951cd08bffa9f5e (diff)
downloadCMake-6a13f43f309dd3484c3339730d141c89ecb27101.zip
CMake-6a13f43f309dd3484c3339730d141c89ecb27101.tar.gz
CMake-6a13f43f309dd3484c3339730d141c89ecb27101.tar.bz2
CONTRIBUTING: Add a section on coding style
Document that we now define our coding style with `clang-format`.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 0e5c7e1..ddf8407 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -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
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
=======