Important

This is part of aDraft of the Python Contributor’s Guide.Text in square brackets are notes about content to fill in.Currently, the devguide and this new Contributor’s Guide co-exist in therepo. We are using Sphinx include directives to demonstrate the re-organization.The final Contributor’s Guide will replace the devguide with content in only oneplace.We welcome help with this!

The[Plan for the Contributor’s Guide] page has more details about the current state of this draftandhow you can help. See more info about the Contributor Guide in thediscussion forum:Refactoring the DevGuide.

[Open question: how to divide content between this Introduction and theintroduction?]

This guide is a comprehensive resource forcontributingtoPython – for both new and experienced contributors. It ismaintained by the same community that maintains Python. We welcome yourcontributions to Python!

We encourage everyone to contribute to Python. This guide should haveeverything you need to get started and be productive. If you still havequestions after reviewing the material in this guide, theCore PythonMentorship group is available to help you through the process.

There are a number of ways to contribute including code, documentation, andtriaging issues. We’ve organized this guide to provide specifics based on thetype of activity you’ll be engaged in.

Using this guide¶

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

No matter what kind of contribution you’ll be making, you should start withthese common sections:

Then choose a path based on your type of activity:

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

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

Documentation	Code	Triaging
Helping with documentation Getting started Style guide reStructuredText primer Translating Helping with the Developer’s Guide	Setup and building Where to get help Lifecycle of a pull request Running and writing tests Fixing “easy” issues (and beyond) Following Python’s development Git bootcamp and cheat sheet Development cycle	Issue tracker Triaging an issue Helping triage issues Experts index GitHub labels GitHub issues for BPO users Triage Team

Core team members will find guidance in theCore team section.

Contents¶

On this page

Python Contributor’s Guide (draft)
- Using this guide
- Contents

Movatterモバイル変換

Python Contributor’s Guide (draft)¶

Using this guide¶

Contents¶