CONTRIBUTING.rst 1.74 KB
Newer Older
1 2 3 4 5 6
Contributing to CMake
*********************

Community
=========

7
CMake is maintained and supported by `Kitware`_ and developed in
8
collaboration with a productive community of contributors.
9 10
Please subscribe and post to the `CMake Developers List`_ to raise
discussion of development topics.
11

12
.. _`Kitware`: http://www.kitware.com/cmake
13
.. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers
14 15 16 17

Patches
=======

18 19 20 21 22 23 24 25 26 27 28
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
29

30 31 32 33 34 35
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.
36
See also the `Utilities/Scripts/clang-format.bash`_ script.
37 38 39

.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
.. _`.clang-format`: .clang-format
40
.. _`Utilities/Scripts/clang-format.bash`: Utilities/Scripts/clang-format.bash
41

42 43 44 45 46
License
=======

We do not require any formal copyright assignment or contributor license
agreement.  Any contributions intentionally sent upstream are presumed
47
to be offered under terms of the OSI-approved BSD 3-clause License.
48 49 50
See `Copyright.txt`_ for details.

.. _`Copyright.txt`: Copyright.txt