README.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. CMake Development
  2. *****************
  3. This directory contains documentation about development of CMake itself.
  4. It is not part of the user documentation distributed with CMake.
  5. Contributor Instructions
  6. ========================
  7. See `CONTRIBUTING.rst`_ for instructions to contribute changes.
  8. The process for contributing changes is the same whether or not one
  9. has been invited to participate directly in upstream development.
  10. .. _`CONTRIBUTING.rst`: ../../CONTRIBUTING.rst
  11. Upstream Development
  12. ====================
  13. CMake uses `Kitware's GitLab Instance`_ to manage development, review, and
  14. integration of changes. The `CMake Repository`_ holds the integration
  15. branches and tags. Upstream development processes are covered by the
  16. following documents:
  17. * The `CMake Review Process`_ manages integration of changes.
  18. * The `CMake Integration Testing`_ infrastructure tests changes
  19. before and after merging.
  20. .. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
  21. .. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake
  22. .. _`CMake Review Process`: review.rst
  23. .. _`CMake Integration Testing`: integration-testing.rst
  24. Developer Documentation
  25. =======================
  26. CMake developer documentation is provided by the following documents:
  27. * The `CMake Source Code Guide`_.
  28. * The `CMake Documentation Guide`_.
  29. * The `CMake Testing Guide`_.
  30. * The `CMake Experimental Features Guide`_.
  31. .. _`CMake Source Code Guide`: source.rst
  32. .. _`CMake Documentation Guide`: documentation.rst
  33. .. _`CMake Testing Guide`: testing.rst
  34. .. _`CMake Experimental Features Guide`: experimental.rst
  35. Maintainer Documentation
  36. ========================
  37. CMake maintainer documentation is provided by the following documents:
  38. * The `CMake Maintainer Guide`_.
  39. .. _`CMake Maintainer Guide`: maint.rst