CMake/CONTRIBUTING.rst
KWSys Upstream a9ea66bd66 KWSys 2016-12-14 (95a7e234)
Code extracted from:

    https://gitlab.kitware.com/utils/kwsys.git

at commit 95a7e234ffd0c6bdfaa8b21c59a119198c050164 (master).

Upstream Shortlog
-----------------

Ben Boeckel (1):
      e0967411 Add a script to help update third-party sources

Brad King (10):
      98505f79 Add script to update GitSetup from upstream
      365edba8 GitSetup: Tell Git not to export .gitattributes
      41a7fe5b Add pre-commit hook to check whether SetupForDevelopment must re-run
      17a1200c Convert developer setup scripts away from Gerrit Code Review
      5f206c3a Tell Git to use a distinct conflict marker size in `.rst` files
      33f828d4 README: Convert from `.txt` to `.rst` markup
      56b707dd README: Add section about reporting bugs
      140357ea CONTRIBUTING: Document contribution through the Kitware GitLab Instance
      4b7bf8e4 Tell Git not to export any `.sh` or `.bash` scripts
      e25eb8dc CONTRIBUTING: Add step for running developer setup script

GitSetup Upstream (3):
      fed3d191 GitSetup 2012-09-27 (341043cf)
      a0144297 GitSetup 2016-12-13 (8af10838)
      868c1e68 GitSetup 2016-12-13 (cd5ada6d)
2016-12-14 11:16:55 -05:00

51 lines
1.7 KiB
ReStructuredText

Contributing to CMake
*********************
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.
#. 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.
.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
.. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
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