summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-08-05 13:22:26 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2014-08-05 13:22:26 (GMT)
commita67b6353940434c856cc332ce490bb6522c32814 (patch)
treeb977ca680e3b5b5ce66fbe42d326dbff56d0931f
parenta6c1d58a09c0c96a83f65b6e67d5eb5982170be7 (diff)
parentd4557188bb4719c81eeeefedf72bc765d7173793 (diff)
downloadCMake-a67b6353940434c856cc332ce490bb6522c32814.zip
CMake-a67b6353940434c856cc332ce490bb6522c32814.tar.gz
CMake-a67b6353940434c856cc332ce490bb6522c32814.tar.bz2
Merge topic 'readme-link-to-issue-tracker'
d4557188 README: Add a section explaining how to report bugs
-rw-r--r--README.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e91b209..e8524f8 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
============