Brad King 8018f2a6c4 Merge topic 'instrumentation' 9 months ago
..
README.rst 8a688e556e Help/dev: Add a CMake Testing Guide 1 year ago
documentation.rst d9ab1fb5da Help/dev: Fix formatting in CMake Documentation Guide 1 year ago
experimental.rst 8018f2a6c4 Merge topic 'instrumentation' 9 months ago
integration-testing.rst 8a688e556e Help/dev: Add a CMake Testing Guide 1 year ago
maint.rst bc8621d999 Fix: A lot of typos in code found by `typos` 9 months ago
review.rst 7cc124d4b5 Help/dev: Move integration testing to a more-specific document 1 year ago
source.rst b4704d3ef8 Help/dev: Improve coding conventions guide 10 months ago
testing.rst 8a688e556e Help/dev: Add a CMake Testing Guide 1 year ago

README.rst

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`_.

.. _`CMake Source Code Guide`: source.rst
.. _`CMake Documentation Guide`: documentation.rst
.. _`CMake Testing Guide`: testing.rst
.. _`CMake Experimental Features Guide`: experimental.rst

Maintainer Documentation
========================

CMake maintainer documentation is provided by the following documents:

* The `CMake Maintainer Guide`_.

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