Commit 75da91ab authored by Brad King's avatar Brad King Committed by Kitware Robot

Merge topic 'doc-development-process'

1cc73e9a CONTRIBUTING: Add link to review process document
9a65b127 CONTRIBUTING: Add link to development documentation README
205ac0f0 CONTRIBUTING: Add note about running developer setup script
9360e6c6 Help/dev: Document the CMake Review Process
d33de80c Help/dev: Exclude this directory from user-facing documentation
Acked-by: Kitware Robot's avatarKitware Robot <kwrobot@kitware.com>
Merge-request: !542
parents 4e8ffb95 1cc73e9a
Pipeline #48563 passed with stage
in 0 seconds
......@@ -806,6 +806,7 @@ if(NOT CMake_TEST_EXTERNAL_CMAKE)
PATTERN "*.sh*" PERMISSIONS OWNER_READ OWNER_EXECUTE OWNER_WRITE
GROUP_READ GROUP_EXECUTE
WORLD_READ WORLD_EXECUTE
REGEX "Help/dev($|/)" EXCLUDE
)
# Install auxiliary files integrating with other tools.
......
Contributing to CMake
*********************
The following summarizes the process for contributing changes.
See documentation on `CMake Development`_ for more information.
.. _`CMake Development`: Help/dev/README.rst
Community
=========
......@@ -19,13 +24,18 @@ CMake uses `Kitware's GitLab Instance`_ to manage development and code review.
To contribute patches:
#. Fork the upstream `CMake Repository`_ into a personal account.
#. Run `Utilities/SetupForDevelopment.sh`_ for local configuration.
#. Base all new work on the upstream ``master`` branch.
#. Create commits making incremental, distinct, logically complete changes.
#. Push a topic branch to a personal repository fork on GitLab.
#. Create a GitLab Merge Request targeting the upstream ``master`` branch.
The merge request will enter the `CMake Review Process`_ for consideration.
.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
.. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh
.. _`CMake Review Process`: Help/dev/review.rst
Code Style
==========
......
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. Changes follow the `CMake Review Process`_ for
integration.
.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
.. _`CMake Review Process`: review.rst
This diff is collapsed.
......@@ -18,7 +18,9 @@ release = '@conf_release@' # full version string
primary_domain = 'cmake'
exclude_patterns = []
exclude_patterns = [
'dev', # ignore developer-only documentation
]
extensions = ['cmake']
templates_path = ['@conf_path@/templates']
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment