CONTRIBUTING.rst 3.02 KB
Newer Older
1 2 3
Contributing to CMake
*********************

4 5 6 7 8
The following summarizes the process for contributing changes.
See documentation on `CMake Development`_ for more information.

.. _`CMake Development`: Help/dev/README.rst

9 10 11
Community
=========

12
CMake is maintained and supported by `Kitware`_ and developed in
13
collaboration with a productive community of contributors.
14 15
Please subscribe and post to the `CMake Developers List`_ to raise
discussion of development topics.
16

17
.. _`Kitware`: http://www.kitware.com/cmake
18
.. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers
19 20 21 22

Patches
=======

23 24 25 26
CMake uses `Kitware's GitLab Instance`_ to manage development and code review.
To contribute patches:

#. Fork the upstream `CMake Repository`_ into a personal account.
27 28
#. Run `Utilities/SetupForDevelopment.sh`_ for local git configuration.
#. See `Building CMake`_ for building CMake locally.
29
#. See the `CMake Source Code Guide`_ for coding guidelines.
30
#. Base all new work on the upstream ``master`` branch.
31 32
   Base work on the upstream ``release`` branch only if it fixes a
   regression or bug in a feature new to that release.
33 34
   If in doubt, prefer ``master``.  Reviewers may simply ask for
   a rebase if deemed appropriate in particular cases.
35 36
#. Create commits making incremental, distinct, logically complete changes
   with appropriate `commit messages`_.
37
#. Push a topic branch to a personal repository fork on GitLab.
38 39
#. Create a GitLab Merge Request targeting the upstream ``master`` branch
   (even if the change is intended for merge to the ``release`` branch).
40 41 42
   Check the box labelled "Allow commits from members who can merge to the
   target branch".  This will allow maintainers to make minor edits on your
   behalf.
43

44 45
The merge request will enter the `CMake Review Process`_ for consideration.

46 47
.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
48
.. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh
49
.. _`Building CMake`: README.rst#building-cmake
50
.. _`CMake Source Code Guide`: Help/dev/source.rst
51
.. _`commit messages`: Help/dev/review.rst#commit-messages
52
.. _`CMake Review Process`: Help/dev/review.rst
53

54 55 56 57 58 59 60 61 62 63 64 65 66 67
CMake Dashboard Client
======================

The *integration testing* step of the `CMake Review Process`_ uses a set of
testing machines that follow an integration branch on their own schedule to
drive testing and submit results to the `CMake CDash Page`_.  Anyone is
welcome to provide testing machines in order to help keep support for their
platforms working.

See documentation on `CMake Testing Process`_ for more information.

.. _`CMake CDash Page`: https://open.cdash.org/index.php?project=CMake
.. _`CMake Testing Process`: Help/dev/testing.rst

68 69 70 71 72
License
=======

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

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