diff options
| author | Brad King <brad.king@kitware.com> | 2016-09-28 15:38:41 -0400 |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2016-09-28 15:38:41 -0400 |
| commit | dfe7af3613f6fff87b2a33c7527d5d24a2fd2d10 (patch) | |
| tree | c0fecd2a46e44a7a9eeac665b237d8130ed30449 | |
| parent | 8f25f37676cb860348738eff4dfb1c3b8bae0b59 (diff) | |
| parent | 03bd9895e3f0bcdc97f051733728ca8869f8fb9e (diff) | |
| download | cmake-dfe7af3613f6fff87b2a33c7527d5d24a2fd2d10.tar.gz | |
Merge topic 'CONTRIBUTING-use-gitlab'
03bd9895 CONTRIBUTING: Document contribution through the Kitware GitLab Instance
2cbfb5c7 CONTRIBUTING: Reference clang-format helper script for code style
| -rw-r--r-- | CONTRIBUTING.rst | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ddf8407e75..921ba7c9b5 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 ========== @@ -29,9 +33,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 ======= |