CMake/Help/dev/README.rst
Brad King 4e52809edf Help/dev: Add a CMake Maintainer Guide document
Initialize it with placeholder content.  This document will serve to
contain instructions for CMake maintenance processes.
2017-06-02 14:24:47 -04:00

50 lines
1.4 KiB
ReStructuredText

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 Testing Process`_ drives integration testing.
.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
.. _`CMake Review Process`: review.rst
.. _`CMake Testing Process`: testing.rst
Developer Documentation
=======================
CMake developer documentation is provided by the following documents:
* The `CMake Source Code Guide`_.
.. _`CMake Source Code Guide`: source.rst
Maintainer Documentation
========================
CMake maintainer documentation is provided by the following documents:
* The `CMake Maintainer Guide`_.
.. _`CMake Maintainer Guide`: maint.rst