CMake Development

*****************

This directory contains documentation about development of CMake itself.

It is not part of the user documentation distributed with CMake.

Contributor Instructions

========================

See `CONTRIBUTING.rst`_ for instructions to contribute changes.

The process for contributing changes is the same whether or not one

has been invited to participate directly in upstream development.

.. _`CONTRIBUTING.rst`: ../../CONTRIBUTING.rst

Upstream Development

====================

CMake uses `Kitware's GitLab Instance`_ to manage development, review, and

integration of changes. The `CMake Repository`_ holds the integration

branches and tags. Upstream development processes are covered by the

following documents:

* The `CMake Review Process`_ manages integration of changes.

* The `CMake Integration Testing`_ infrastructure tests changes

before and after merging.

.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com

.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake

.. _`CMake Review Process`: review.rst

.. _`CMake Integration Testing`: integration-testing.rst

Developer Documentation

=======================

CMake developer documentation is provided by the following documents:

* The `CMake Source Code Guide`_.

* The `CMake Documentation Guide`_.

* The `CMake Testing Guide`_.

* The `CMake Experimental Features Guide`_.

* The `CMake Debugging Guide`_.

* The `CMake Diagnostics Guide`_.

.. _`CMake Source Code Guide`: source.rst

.. _`CMake Documentation Guide`: documentation.rst

.. _`CMake Testing Guide`: testing.rst

.. _`CMake Experimental Features Guide`: experimental.rst

.. _`CMake Debugging Guide`: debug.rst

.. _`CMake Diagnostics Guide`: diagnostics.rst

Maintainer Documentation

========================

CMake maintainer documentation is provided by the following documents:

* The `CMake Maintainer Guide`_.

.. _`CMake Maintainer Guide`: maint.rst