[Python-checkins] devguide: Suggest asking before reporting an issue

antoine.pitrou python-checkins at python.org
Wed Jan 26 00:00:31 CET 2011


antoine.pitrou pushed 610f94fe660c to devguide:

http://hg.python.org/devguide/rev/610f94fe660c
changeset:   206:610f94fe660c
tag:         tip
user:        Antoine Pitrou <solipsis at pitrou.net>
date:        Wed Jan 26 00:00:28 2011 +0100
summary:
  Suggest asking before reporting an issue

files:
  help.rst

diff --git a/help.rst b/help.rst
--- a/help.rst
+++ b/help.rst
@@ -2,23 +2,13 @@
 
 Where to Get Help
 =================
+
 If you are working on Python it is very possible you will come across an issue
 where you need some assistance in solving (this happens to core developers all
 the time). Below are some options on getting help.
 
 If the question involves process or tool usage then please check other parts of
-the developer's guide first as it should answer your question.
-
-
-File a Bug
-----------
-If you come across an odd error message that seems like a bug, then file a bug
-on the `issue tracker`_. In the bug you can explain that you are not sure why
-the error is coming up or what the exact nature of the problem is. Someone will
-come along and help you diagnose the problem, evolving the bug report into a
-more concrete issue.
-
-.. _issue tracker: http://bugs.python.org
+this guide first as it should answer your question.
 
 
 Ask (#)python-dev
@@ -33,3 +23,17 @@
 <http://mail.python.org/mailman/listinfo/python-dev>`_ for help with your
 question. Just remember that both avenues are for questions involving the
 development *of* Python, **not** for development *with* Python.
+
+
+File a Bug
+----------
+
+If you strongly suspect you have stumbled on a bug (be it in the build
+process, in the test suite, or in other areas), then open a issue on the
+`issue tracker`_.  As with every bug report it is strongly advised that
+you detail which conditions triggered it (including the OS name and version,
+and what you were trying to do), as well as the exact error message you
+encountered.
+
+.. _issue tracker: http://bugs.python.org
+

--
Repository URL: http://hg.python.org/devguide


More information about the Python-checkins mailing list