CONTRIBUTING.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. Contributing to CMake
  2. *********************
  3. The following summarizes the process for contributing changes.
  4. See documentation on `CMake Development`_ for more information.
  5. .. _`CMake Development`: Help/dev/README.rst
  6. Community
  7. =========
  8. CMake is maintained and supported by `Kitware`_ and developed in
  9. collaboration with a productive community of contributors.
  10. Please subscribe and post to the `CMake Developers List`_ to raise
  11. discussion of development topics.
  12. .. _`Kitware`: http://www.kitware.com/cmake
  13. .. _`CMake Developers List`: https://cmake.org/mailman/listinfo/cmake-developers
  14. Patches
  15. =======
  16. CMake uses `Kitware's GitLab Instance`_ to manage development and code review.
  17. To contribute patches:
  18. #. Fork the upstream `CMake Repository`_ into a personal account.
  19. #. Run `Utilities/SetupForDevelopment.sh`_ for local configuration.
  20. #. See the `CMake Source Code Guide`_ for coding guidelines.
  21. #. Base all new work on the upstream ``master`` branch.
  22. Base work on the upstream ``release`` branch only if it fixes a
  23. regression or bug in a feature new to that release.
  24. #. Create commits making incremental, distinct, logically complete changes
  25. with appropriate `commit messages`_.
  26. #. Push a topic branch to a personal repository fork on GitLab.
  27. #. Create a GitLab Merge Request targeting the upstream ``master`` branch
  28. (even if the change is intended for merge to the ``release`` branch).
  29. The merge request will enter the `CMake Review Process`_ for consideration.
  30. .. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
  31. .. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
  32. .. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh
  33. .. _`CMake Source Code Guide`: Help/dev/source.rst
  34. .. _`commit messages`: Help/dev/review.rst#commit-messages
  35. .. _`CMake Review Process`: Help/dev/review.rst
  36. License
  37. =======
  38. We do not require any formal copyright assignment or contributor license
  39. agreement. Any contributions intentionally sent upstream are presumed
  40. to be offered under terms of the OSI-approved BSD 3-clause License.
  41. See `Copyright.txt`_ for details.
  42. .. _`Copyright.txt`: Copyright.txt