CMake/CONTRIBUTING.rst

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
=========

CMake is maintained and supported by `Kitware`_ and developed in
collaboration with a productive community of contributors.
Please subscribe and post to the `CMake Developers List`_ to raise
discussion of development topics.

.. _`Kitware`: http://www.kitware.com/cmake
.. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers

Patches
=======

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
==========

We use `clang-format`_ to define our style for C++ code in the CMake source
tree.  See the `.clang-format`_ configuration file for our style settings.
Use ``clang-format`` version 3.8 or higher to format source files.
See also the `Utilities/Scripts/clang-format.bash`_ script.

.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
.. _`.clang-format`: .clang-format
.. _`Utilities/Scripts/clang-format.bash`: Utilities/Scripts/clang-format.bash

License
=======

We do not require any formal copyright assignment or contributor license
agreement.  Any contributions intentionally sent upstream are presumed
to be offered under terms of the OSI-approved BSD 3-clause License.
See `Copyright.txt`_ for details.

.. _`Copyright.txt`: Copyright.txt
Update README and add guidelines for CONTRIBUTING Rename 'Readme.txt' to 'README.rst', format the documentation as reStructuredText, and modernize the content. Also add a new 'CONTRIBUTING.rst' explaining the preferred entry path for new contributors. 2014-01-29 15:56:27 +00:00			`Contributing to CMake`
			`*********************`

CONTRIBUTING: Add link to development documentation README 2017-02-23 20:56:50 +00:00			`The following summarizes the process for contributing changes.`
			See documentation on `CMake Development`_ for more information.

			.. _`CMake Development`: Help/dev/README.rst

Update README and add guidelines for CONTRIBUTING Rename 'Readme.txt' to 'README.rst', format the documentation as reStructuredText, and modernize the content. Also add a new 'CONTRIBUTING.rst' explaining the preferred entry path for new contributors. 2014-01-29 15:56:27 +00:00			`Community`
			`=========`

Simplify and clarify credit text and link Use the name "Kitware" rather than "Kitware, Inc." to simplify the text. Provide a CMake-specific URL. 2014-06-03 13:19:57 +00:00			CMake is maintained and supported by `Kitware`_ and developed in
README: Credit Kitware and community of contributors 2014-02-03 16:10:02 +00:00			`collaboration with a productive community of contributors.`
CONTRIBUTING: Document contribution through the Kitware GitLab Instance Replace the instructions that routed patches to the mailing list with new instructions routing them to our GitLab instance. 2016-09-28 19:16:19 +00:00			Please subscribe and post to the `CMake Developers List`_ to raise
			`discussion of development topics.`
README: Credit Kitware and community of contributors 2014-02-03 16:10:02 +00:00
Simplify and clarify credit text and link Use the name "Kitware" rather than "Kitware, Inc." to simplify the text. Provide a CMake-specific URL. 2014-06-03 13:19:57 +00:00			.. _`Kitware`: http://www.kitware.com/cmake
Replace http://www.cmake.org URLs with https://cmake.org The latter is now the preferred URL for visiting cmake.org with a browser. Convert using the shell code: git ls-files -z \| xargs -0 sed -i 's\|http://www\.cmake\|https://cmake\|g' 2015-09-25 19:44:12 +00:00			.. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers
Update README and add guidelines for CONTRIBUTING Rename 'Readme.txt' to 'README.rst', format the documentation as reStructuredText, and modernize the content. Also add a new 'CONTRIBUTING.rst' explaining the preferred entry path for new contributors. 2014-01-29 15:56:27 +00:00
			`Patches`
			`=======`

CONTRIBUTING: Document contribution through the Kitware GitLab Instance Replace the instructions that routed patches to the mailing list with new instructions routing them to our GitLab instance. 2016-09-28 19:16:19 +00:00			CMake uses `Kitware's GitLab Instance`_ to manage development and code review.
			`To contribute patches:`

			#. Fork the upstream `CMake Repository`_ into a personal account.
CONTRIBUTING: Add note about running developer setup script 2017-02-23 19:10:56 +00:00			#. Run `Utilities/SetupForDevelopment.sh`_ for local configuration.
CONTRIBUTING: Document contribution through the Kitware GitLab Instance Replace the instructions that routed patches to the mailing list with new instructions routing them to our GitLab instance. 2016-09-28 19:16:19 +00:00			#. 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.

CONTRIBUTING: Add link to review process document 2017-02-23 19:56:00 +00:00			The merge request will enter the `CMake Review Process`_ for consideration.

CONTRIBUTING: Document contribution through the Kitware GitLab Instance Replace the instructions that routed patches to the mailing list with new instructions routing them to our GitLab instance. 2016-09-28 19:16:19 +00:00			.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
			.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
CONTRIBUTING: Add note about running developer setup script 2017-02-23 19:10:56 +00:00			.. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh
CONTRIBUTING: Add link to review process document 2017-02-23 19:56:00 +00:00			.. _`CMake Review Process`: Help/dev/review.rst
Update README and add guidelines for CONTRIBUTING Rename 'Readme.txt' to 'README.rst', format the documentation as reStructuredText, and modernize the content. Also add a new 'CONTRIBUTING.rst' explaining the preferred entry path for new contributors. 2014-01-29 15:56:27 +00:00
CONTRIBUTING: Add a section on coding style Document that we now define our coding style with `clang-format`. 2016-05-16 14:53:59 +00:00			`Code Style`
			`==========`

			We use `clang-format`_ to define our style for C++ code in the CMake source
			tree. See the `.clang-format`_ configuration file for our style settings.
			Use ``clang-format`` version 3.8 or higher to format source files.
CONTRIBUTING: Reference clang-format helper script for code style 2016-09-28 15:46:40 +00:00			See also the `Utilities/Scripts/clang-format.bash`_ script.
CONTRIBUTING: Add a section on coding style Document that we now define our coding style with `clang-format`. 2016-05-16 14:53:59 +00:00
			.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
			.. _`.clang-format`: .clang-format
CONTRIBUTING: Reference clang-format helper script for code style 2016-09-28 15:46:40 +00:00			.. _`Utilities/Scripts/clang-format.bash`: Utilities/Scripts/clang-format.bash
CONTRIBUTING: Add a section on coding style Document that we now define our coding style with `clang-format`. 2016-05-16 14:53:59 +00:00
Update README and add guidelines for CONTRIBUTING Rename 'Readme.txt' to 'README.rst', format the documentation as reStructuredText, and modernize the content. Also add a new 'CONTRIBUTING.rst' explaining the preferred entry path for new contributors. 2014-01-29 15:56:27 +00:00			`License`
			`=======`

			`We do not require any formal copyright assignment or contributor license`
			`agreement. Any contributions intentionally sent upstream are presumed`
CONTRIBUTING: Spell "offered" correctly Reported-by: Radovan Bast 2015-07-02 13:08:35 +00:00			`to be offered under terms of the OSI-approved BSD 3-clause License.`
Update README and add guidelines for CONTRIBUTING Rename 'Readme.txt' to 'README.rst', format the documentation as reStructuredText, and modernize the content. Also add a new 'CONTRIBUTING.rst' explaining the preferred entry path for new contributors. 2014-01-29 15:56:27 +00:00			See `Copyright.txt`_ for details.

			.. _`Copyright.txt`: Copyright.txt