[Plan for the Contributor’s Guide]

Important

This is part of a Draft 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 the repo. We are using Sphinx include directives to demonstrate the re-organization. The final Contributor’s Guide will replace the devguide with content in only one place. We welcome help with this!

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

We are in the process of updating and refactoring the devguide to be a Contributor’s Guide. It will highlight the different kinds of contribution possible, and how to succeed at each kind.

Currently, the Contibutor’s Guide is a draft in this new last section of the devguide. We welcome feedback, but please understand that some of the current content is moving or skeletal.

Repo structure

While the reorganization is happening, we are keeping the old devguide as it is. The new Contributor’s Guide is represented in this last section, but will eventually be the only content in the guide. To avoid copying content, we’re using Sphinx include directives to display existing devguide content in its new Contributor’s Guide location. That is not how the eventual Guide will be built. Once we are ready to make the Contributor’s Guide real, we will rearrange content into its new location.

How to help

To help, you can: