summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-08-04 09:41:37 -0400
committerBrad King <brad.king@kitware.com>2014-08-04 09:49:49 -0400
commitd4557188bb4719c81eeeefedf72bc765d7173793 (patch)
tree6d6e6c604436ec6f0da49f165a3a2f0f623da373 /README.rst
parentb0f6d3eb9969dc60cbbf8d151207852f88b62380 (diff)
downloadcmake-d4557188bb4719c81eeeefedf72bc765d7173793.tar.gz
README: Add a section explaining how to report bugs
Suggested-by: Petr Bena <benapetr@gmail.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e91b209334..e8524f81a3 100644
--- a/README.rst
+++ b/README.rst
@@ -75,6 +75,22 @@ For instructions how to do this, see documentation on `Running CMake`_.
.. _`Running CMake`: http://www.cmake.org/cmake/help/runningcmake.html
+Reporting Bugs
+==============
+
+If you have found a bug:
+
+1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.
+
+2. Otherwise, please join the the `CMake Users List`_ and ask about
+ the expected and observed behaviors to determine if it is really
+ a bug.
+
+3. Finally, if the issue is not resolved by the above steps, open
+ an entry in the `CMake Issue Tracker`_.
+
+.. _`CMake Issue Tracker`: http://www.cmake.org/Bug
+
Contributing
============