4 The following summarizes the process for contributing changes.
5 See documentation on `CMake Development`_ for more information.
7 .. _`CMake Development`: Help/dev/README.rst
12 CMake is maintained and supported by `Kitware`_ and developed in
13 collaboration with a productive community of contributors.
14 Please subscribe and post to the `CMake Developers List`_ to raise
15 discussion of development topics.
17 .. _`Kitware`: http://www.kitware.com/cmake
18 .. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers
23 CMake uses `Kitware's GitLab Instance`_ to manage development and code review.
24 To contribute patches:
26 #. Fork the upstream `CMake Repository`_ into a personal account.
27 #. Run `Utilities/SetupForDevelopment.sh`_ for local git configuration.
28 #. 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 Base work on the upstream ``release`` branch only if it fixes a
32 regression or bug in a feature new to that release.
33 If in doubt, prefer ``master``. Reviewers may simply ask for
34 a rebase if deemed appropriate in particular cases.
35 #. Create commits making incremental, distinct, logically complete changes
36 with appropriate `commit messages`_.
37 #. Push a topic branch to a personal repository fork on GitLab.
38 #. Create a GitLab Merge Request targeting the upstream ``master`` branch
39 (even if the change is intended for merge to the ``release`` branch).
40 Check the box labelled "Allow commits from members who can merge to the
41 target branch". This will allow maintainers to make minor edits on your
44 The merge request will enter the `CMake Review Process`_ for consideration.
46 .. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
47 .. _`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
54 CMake Dashboard Client
55 ======================
57 The *integration testing* step of the `CMake Review Process`_ uses a set of
58 testing machines that follow an integration branch on their own schedule to
59 drive testing and submit results to the `CMake CDash Page`_. Anyone is
60 welcome to provide testing machines in order to help keep support for their
63 See documentation on `CMake Testing Process`_ for more information.
65 .. _`CMake CDash Page`: https://open.cdash.org/index.php?project=CMake
66 .. _`CMake Testing Process`: Help/dev/testing.rst
71 We do not require any formal copyright assignment or contributor license
72 agreement. Any contributions intentionally sent upstream are presumed
73 to be offered under terms of the OSI-approved BSD 3-clause License.
74 See `Copyright.txt`_ for details.
76 .. _`Copyright.txt`: Copyright.txt