[Python-checkins] devguide: Short doc about where to get tech help related to developing Python.

[brett.cannon]

brett.cannon pushed 127b8639418d to devguide:

http://hg.python.org/devguide/rev/127b8639418d
changeset:   149:127b8639418d
tag:         tip
user:        Brett Cannon <brett at python.org>
date:        Wed Jan 19 14:19:44 2011 -0800
summary:
  Short doc about where to get tech help related to developing Python.

files:
  help.rst
  index.rst

diff --git a/help.rst b/help.rst
new file mode 100644
--- /dev/null
+++ b/help.rst
@@ -0,0 +1,31 @@
+.. _help:
+
+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). You have a couple of options depending on what kind of help you need.
+If the question involves process or tool usage then please check the developer's
+guide first as is should answer your question.
+
+
+Filing 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 that 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
+
+
+Asking a Technical Question
+---------------------------
+You have two avenues of communication out of the :ref:`myriad of options
+available <communication>`. If you are comfortable with IRC you can try asking
+in #python-dev. Typically there are a couple of experienced developers, ranging
+from triagers to core developers, who can ask questions about developing for
+Python. If you prefer email you can email 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.
diff --git a/index.rst b/index.rst
--- a/index.rst
+++ b/index.rst
@@ -5,6 +5,7 @@
    :hidden:
 
    setup
+   help
    patch
    runtests
    coverage
@@ -40,6 +41,7 @@
     * `PEP 7`_
     * `PEP 8`_
 * :ref:`patch`
+* :ref:`help`
 * :ref:`runtests`
 * Beginner tasks to become familiar with the development process
     * :ref:`docquality`
@@ -86,8 +88,6 @@
 .. _PEP 8: http://www.python.org/dev/peps/pep-0008
 
 
-.. todo:: something about where people can turn to for help
-
 .. todo::
     move various files out of Misc to here (e.g., README.valgrind,
     Porting, SpecialBuilds.txt, maintainers.rst, etc.); asked python-dev on

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