Contributing to Python: Difference between revisions

Content added Content deleted
imported>Jesstess
No edit summary
imported>Jesstess
No edit summary
Line 1: Line 1:
Welcome! This page contains instructions for prospective OPW and Google Summer of Code interns, as well as anyone else interested in contributing to Python.
Welcome! This page contains instructions for getting started with contributing to Python. They cover practicing some of the common tools of open source development, as well as contributing specifically to Python.


= Part 1: environment setup =
= Part 1: environment setup =
Line 51: Line 51:
== Goal #1: join the mailing list ==
== Goal #1: join the mailing list ==


The Python community has a lot of mailing lists. The 2 big ones for new contributors are:
Join the Python core-mentorship mailing list and introduce yourself: https://mail.python.org/mailman/listinfo/core-mentorship.

# core-mentorship: https://mail.python.org/mailman/listinfo/core-mentorship. This is a great place to ask questions about contributing, ask for reviews, and get suggestions for bugs to work on.
# python-dev: https://mail.python.org/mailman/listinfo/python-dev. The main mailing list for developing and releasing Python. Please do not ask general Python questions on this list.

The core-mentorship mailing list will be our focus as we get settled in, so please [[https://mail.python.org/mailman/listinfo/core-mentorship|join the list]] now.


== Goal #2: read the developer guide ==
== Goal #2: read the developer guide ==


Read the Python developer guide: http://docs.python.org/devguide/
Python has excellent documentation for getting started with contribution in its developer guide: http://docs.python.org/devguide/

Please read through the following sections of the developer guide:

# Quick start: http://docs.python.org/devguide/#quick-start
# Setup: http://docs.python.org/devguide/setup.html
# Where to get help: http://docs.python.org/devguide/help.html
# The lifecycle of a patch: http://docs.python.org/devguide/patch.html
# Writing and running tests: http://docs.python.org/devguide/runtests.html
# Using the issue tracker: http://docs.python.org/devguide/tracker.html#tracker
# The CPython development cycle: http://docs.python.org/devguide/devcycle.html

By the end, you'll:

* Have downloaded the Python source code
* Built Python
* Run the test suite
* Have an overview of the development cycle.

Don't worry if this doesn't feel fully digested yet! The process will become clearer with practice.


== Goal #3: submit a patch for a Python bug ==
== Goal #3: submit a patch for a Python bug ==