diff -r 57b2525fa1ee faq.rst --- a/faq.rst Tue Jul 14 21:27:24 2015 -0400 +++ b/faq.rst Wed Jul 22 17:50:50 2015 -0700 @@ -12,6 +12,7 @@ Communications ============== +.. _general-questions: Where should I ask general Python questions? -------------------------------------------- @@ -89,6 +90,7 @@ .. _python-dev: http://mail.python.org/mailman/listinfo/python-dev +.. _faq-issue-resolution: What if I disagree with an issue resolution on the tracker? ----------------------------------------------------------- @@ -116,6 +118,8 @@ .. _full list of developers: https://hg.python.org/committers.txt +.. _standards-behaviour: + What standards of behaviour are expected in these communication channels? ------------------------------------------------------------------------- diff -r 57b2525fa1ee help.rst --- a/help.rst Tue Jul 14 21:27:24 2015 -0400 +++ b/help.rst Wed Jul 22 17:50:50 2015 -0700 @@ -25,6 +25,7 @@ .. _freenode: http://freenode.net/ +.. _help-core-mentorship: Core Mentorship --------------- @@ -38,6 +39,7 @@ .. _Python Mentors: http://pythonmentors.com +.. _help-mailing-lists: Mailing Lists ------------- diff -r 57b2525fa1ee index.rst --- a/index.rst Tue Jul 14 21:27:24 2015 -0400 +++ b/index.rst Wed Jul 22 17:50:50 2015 -0700 @@ -2,17 +2,55 @@ Python Developer's Guide ======================== -This guide is a comprehensive resource for :ref:`contributing ` -to Python_ -- for both new and experienced contributors. It is +Welcome to the Python developer community's comprehensive resource for +:ref:`contributing ` to Python_. The guide shares information that +new, developing, and experienced contributors have found helpful. It is :ref:`maintained ` by the same community -that maintains Python. We welcome your contributions to Python! +that maintains Python, and we hope you will share it with others. -Quick Start ------------ +Quick Start: Community workflow +------------------------------- -Here are the basic steps needed to get :ref:`set up ` and contribute a -patch: +Our Python development community works to grow and improve the Python language. +We also sustain and maintain many projects that support our developers. It's a +big job with many contributors pitching in their time and ideas. + +To be an effective developer, these community workflow actions are critical: + +1. Use `Python Mentors`_ and its :ref:`core mentorship ` + resources. + +2. Learn the :ref:`mailing lists ` and use them effectively. + + * `tutor`_, `python-help`_, `python-list`_ for + :ref:`general questions ` + * `python-ideas`_ for :ref:`suggesting new features ` + * `python-dev`_ for current development, release mechanics and maintenance, + and :ref:`issue resolution of disagreements ` + * `python-bugs-list`_, `new-bugs-announce`_ + * `docs`_ + +3. Respect community expectations. + +4. Strive for high :ref:`standards of behavior `. + + * Everyone makes mistakes. Apologize if you do. + * When we disagree, please keep discussion on the issue and its improvement. + * Avoid rehashing history. Offer constructive options and be open to + compromise. + * Consider that developers contribute care and time to do their best. + * Pause and recharge as needed. + +Constructive community workflow creates more opportunities for Python +excellence. Be a part of it! + + +Quick Start: Code development +----------------------------- + +Here are the basic steps needed to :ref:`set up ` your development +environment and contribute a patch: 1. :ref:`Get the source code `:: @@ -40,8 +78,10 @@ with :file:`./python.exe`. On Windows, use :file:`python.bat` or check the :ref:`Windows instructions `. With Python 2.7, replace ``test`` with ``test.regrtest``. + 4. Make the :doc:`patch `. -5. Submit it to the `issue tracker`_. + +5. Submit the patch to the `issue tracker`_. Quick Links @@ -74,10 +114,10 @@ * :doc:`help` * :doc:`patch` * :doc:`runtests` -* Beginner tasks to become familiar with the development process +* Starter tasks to become familiar with the development process * :doc:`docquality` * :doc:`coverage` -* Advanced tasks for once you are comfortable +* Additional tasks for once you are comfortable with the development process * :doc:`silencewarnings` * Fixing issues found by the :doc:`buildbots ` * :doc:`fixingissues` @@ -232,3 +272,11 @@ .. _IronPython: http://ironpython.net/ .. _Stackless: http://www.stackless.com/ .. _Issue tracker: http://bugs.python.org/ +.. _python-ideas: http://mail.python.org/mailman/listinfo/python-ideas +.. _python-dev: http://mail.python.org/mailman/listinfo/python-dev +.. _tutor: http://mail.python.org/mailman/listinfo/tutor +.. _python-help: http://mail.python.org/mailman/listinfo/python-help +.. _python-list: http://mail.python.org/mailman/listinfo/python-list +.. _docs: http://mail.python.org/mailman/listinfo/docs +.. _python-bugs-list: http://mail.python.org/mailman/listinfo/python-bugs-list +.. _new-bugs-announce: http://mail.python.org/mailman/listinfo/new-bugs-announce