From 6a13f43f309dd3484c3339730d141c89ecb27101 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 16 May 2016 10:53:59 -0400 Subject: CONTRIBUTING: Add a section on coding style Document that we now define our coding style with `clang-format`. --- CONTRIBUTING.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) 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 ======= -- cgit v0.12