diff options
| author | Brad King <brad.king@kitware.com> | 2016-05-16 10:53:59 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-05-16 16:04:46 -0400 |
| commit | 6a13f43f309dd3484c3339730d141c89ecb27101 (patch) | |
| tree | 3e5ea77fd3ebeb0dae57dedbed9d6522c89cea51 /CONTRIBUTING.rst | |
| parent | bf451d9ff92fb8240dbb0e7af951cd08bffa9f5e (diff) | |
| download | cmake-6a13f43f309dd3484c3339730d141c89ecb27101.tar.gz | |
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.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0e5c7e1441..ddf8407e75 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 ======= |