From 2cbfb5c7a4000f27e93fde178ce3659dca0dbb6e Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 28 Sep 2016 11:46:40 -0400 Subject: [PATCH 1/2] CONTRIBUTING: Reference clang-format helper script for code style --- CONTRIBUTING.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ddf8407e7..30079006a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -29,9 +29,11 @@ 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. +See also the `Utilities/Scripts/clang-format.bash`_ script. .. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html .. _`.clang-format`: .clang-format +.. _`Utilities/Scripts/clang-format.bash`: Utilities/Scripts/clang-format.bash License ======= From 03bd9895e3f0bcdc97f051733728ca8869f8fb9e Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 28 Sep 2016 15:16:19 -0400 Subject: [PATCH 2/2] CONTRIBUTING: Document contribution through the Kitware GitLab Instance Replace the instructions that routed patches to the mailing list with new instructions routing them to our GitLab instance. --- CONTRIBUTING.rst | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 30079006a..921ba7c9b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -6,22 +6,26 @@ Community CMake is maintained and supported by `Kitware`_ and developed in collaboration with a productive community of contributors. +Please subscribe and post to the `CMake Developers List`_ to raise +discussion of development topics. .. _`Kitware`: http://www.kitware.com/cmake - -The preferred entry point for new contributors is the mailing list. -Please subscribe and post to the `CMake Developers List`_ to offer -contributions. Regular and productive contributors may be invited -to gain direct push access. - .. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers Patches ======= -Please base all new work on the ``master`` branch. Then use -``git format-patch`` to produce patches suitable to post to -the mailing list. +CMake uses `Kitware's GitLab Instance`_ to manage development and code review. +To contribute patches: + +#. Fork the upstream `CMake Repository`_ into a personal account. +#. Base all new work on the upstream ``master`` branch. +#. Create commits making incremental, distinct, logically complete changes. +#. Push a topic branch to a personal repository fork on GitLab. +#. Create a GitLab Merge Request targeting the upstream ``master`` branch. + +.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com +.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake Code Style ==========