index.rst

Python Contributor's Guide (draft)

Important

|draft|

|purpose|

[Open question: how to divide content between this Introduction and the :ref:`introduction <c_intro>`?]

This guide is a comprehensive resource for :ref:`contributing <contributing>` to Python -- for both new and experienced contributors. It is :ref:`maintained <devguide>` by the same community that maintains Python. We welcome your contributions to Python!

We encourage everyone to contribute to Python. This guide should have everything you need to get started and be productive. If you still have questions after reviewing the material in this guide, the Core Python Mentorship group is available to help you through the process.

There are a number of ways to contribute including code, documentation, and triaging issues. We've organized this guide to provide specifics based on the type of activity you'll be engaged in.

Using this guide

We recommend reading this guide as needed. You can stop where you feel comfortable and begin contributing immediately without reading and understanding everything. If you do choose to skip around this guide, be aware that it is written assuming preceding sections have been read so you may need to backtrack to fill in missing concepts and terminology.

No matter what kind of contribution you'll be making, you should start with these common sections:

• :ref:`c_intro`
• :ref:`c_project`

Then choose a path based on your type of activity:

[The original table on the devguide home had a fourth column for Core Developers. That made the table wider and more confusing. I don't think core team members need a quick intro path since they will have been through the devguide before.]

[I haven't adjusted the links in the table yet other than to add a link to the major section at the top of each column.]

:ref:`Documentation <c_docs>`	:ref:`Code <c_code>`	:ref:`Triaging <c_triage>`
:ref:`docquality` :ref:`documenting` :ref:`style-guide` :ref:`rst-primer` :ref:`translating` :ref:`devguide`	:ref:`setup` :ref:`help` :ref:`pullrequest` :ref:`runtests` :ref:`fixingissues` :ref:`communication` :ref:`gitbootcamp` :ref:`devcycle`	:ref:`tracker` :ref:`triaging` :ref:`helptriage` :ref:`experts` :ref:`labels` :ref:`gh-faq` :ref:`triage-team`

Core team members will find guidance in the :ref:`c_coreteam` section.

Contents

.. toctree::
   :maxdepth: 3

   contrib-plan
   intro/index
   project/index
   triage/index
   doc/index
   code/index
   core-team/index
   user-success
   security
   workflows/index