From d4557188bb4719c81eeeefedf72bc765d7173793 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 4 Aug 2014 09:41:37 -0400 Subject: [PATCH] README: Add a section explaining how to report bugs Suggested-by: Petr Bena --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index e91b20933..e8524f81a 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 ============