kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/CONTRIBUTING.rst

45 lines
1.3 KiB
ReStructuredText
Raw Normal View History

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 19:56:27 +04:00
Contributing to CMake
*********************
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 17:19:57 +04:00
CMake is maintained and supported by `Kitware`_ and developed in
README: Credit Kitware and community of contributors
2014-02-03 20:10:02 +04:00
collaboration with a productive community of contributors.
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 17:19:57 +04:00
.. _`Kitware`: http://www.kitware.com/cmake
README: Credit Kitware and community of contributors
2014-02-03 20:10:02 +04: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 19:56:27 +04:00
The preferred entry point for new contributors is the mailing list.
Please subscribe and post to the `CMake Developers List`_ to offer
contributions. Regular and productive contributors may be invited
to gain direct push access.
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 22:44:12 +03: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 19:56:27 +04:00
Patches
=======
Please base all new work on the ``master`` branch. Then use
``git format-patch`` to produce patches suitable to post to
the mailing list.
CONTRIBUTING: Add a section on coding style Document that we now define our coding style with `clang-format`.
2016-05-16 17:53:59 +03: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.
.. _`clang-format`: http://clang.llvm.org/docs/ClangFormat.html
.. _`.clang-format`: .clang-format
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 19:56:27 +04: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 16:08:35 +03: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 19:56:27 +04:00
See `Copyright.txt`_ for details.
.. _`Copyright.txt`: Copyright.txt