Contributing to Python: Difference between revisions

← Older edit

Contributing to Python (view source)

Revision as of 17:15, 5 March 2014

494 bytes added , 10 years ago

m

Protected "Contributing to Python" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))

Anonymous user

imported>Jesstess

Revision as of 14:59, 5 March 2014 (view source) imported>Jesstess No edit summary ← Older edit		Latest revision as of 17:15, 5 March 2014 (view source) imported>Jesstess m (Protected "Contributing to Python" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
(26 intermediate revisions by the same user not shown)
Line 1: 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 steps for contributing specifically to Python. These instructions were written for prospective [~~https~~http://wiki.python.org/moin/OPW/2014\| GNOME Outreach Program for Women] and [~~https~~http://wiki.python.org/moin/SummerOfCode/2014\| Google Summer of Code] interns, but are relevant for anyone interested in contributing to CPython and the standard library. [[File:Python_logo.png\|200px]] [[File:Opw.png\|200px]] [[File:Pyladies_logo.png\|200px]] = Part 1: environment setup = == Goal #1: install an IRC client == [[File:Chat.png\|100px]] IRC is a real-time chat protocol that open source projects often use to talk about the project and as a medium for users and developers to help each other. Line 14 ⟶ 18: * [[Contributing_to_Python/OSX IRC\|OS X]] * [[Contributing_to_Python/Linux IRC\|Linux]] == Goal #2: practice navigating from the command line == [[File:Utilities-terminal.png\|100px]] Many of the tools of open source development are primarily used via the command line. Let's get some practice with navigating the computer from the command line. Line 22 ⟶ 29: * [[Contributing_to_Python/OSX command line\|OS X]] * [[Contributing_to_Python/Linux command line\|Linux]] == Goal #3: Get familiar with the Python bug tracker == [[File:Bug.png\|100px]] ~~Python tracks bugs and features at http://bugs.python.org/.~~ ~~First,~~Python ~~please~~tracks ~~create~~bugs anand ~~account~~features onat http://bugs.python.org/. Please create an account on this site now. Next, ~~please~~ familiarize yourself with how Python uses its bug tracker by exploring and finding answers to the following questions: # What is the oldest open Python ticket? # How many open issues need a patch? # How many "critical"-level open issues are there? == Goal #4: practice using version control == [[File:History.png\|100px]] Mercurial is the distributed version control system Python uses to manages changes to its code. Please [http://mercurial.selenic.com/downloads/ download and install Mercurial now]. If you have not used Mercurial before, please go through this tutorial: http://hginit.com/▼ ▲If you have not used Mercurial before, please go through ~~this tutorial:~~ [http://~~hginit~~hgbook.red-bean.com/read/a-tour-of-mercurial-the-basics.html this tutorial]. == Goal #5: practice creating patches == [[File:Patch.png\|100px]] Code changes are represented in a concise and standard format called a "diff". <tt>patch</tt> is a utility which applies a "diff" to someone else's copy of the code. Line 48 ⟶ 64: http://openhatch.org/missions/diffpatch = Part II: contributing to Python = == Goal #1: join the mailing list == [[File:Email.png\|100px]] The Python community has a lot of mailing lists. The 2 big ones for new contributors are: # ~~core-mentorship: https~~[http://mail.python.org/mailman/listinfo/core-mentorship. 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~~[http://mail.python.org/mailman/listinfo/python-dev. 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~~http://mail.python.org/mailman/listinfo/core-mentorship\| join the list]] now.▼ ▲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 == [[File:Safari.png\|100px]] Python has excellent documentation for getting started with contribution in its developer guide: http://docs.python.org/devguide/ Line 66 ⟶ 88: Please read through the following sections of the developer guide: # ~~Quick start:~~ [http://docs.python.org/devguide/#quick-start Quick start] # ~~Setup:~~ [http://docs.python.org/devguide/setup.html Setup] # ~~Where to get help:~~ [http://docs.python.org/devguide/help.html Where to get help] # ~~The lifecycle of a patch:~~ [http://docs.python.org/devguide/patch.html The lifecycle of a patch] # ~~Writing and running tests:~~ [http://docs.python.org/devguide/runtests.html Writing and running tests] # ~~Using the issue tracker:~~ [http://docs.python.org/devguide/tracker.html#tracker Using the issue tracker] # ~~The CPython development cycle:~~ [http://docs.python.org/devguide/devcycle.html The CPython development cycle] By the end, you'll: Line 82 ⟶ 104: Don't worry if this doesn't feel fully digested yet! The process will become clearer with practice. == Goal #3: pick a bug to work on == [[File:Debugging.png\|100px]] It's time to pick a Python bug to work on! Visit http://bugs.python.org/ and browse for one that looks good. Line 91 ⟶ 116: First, the developer guide suggests 2 good areas for first-time contributors: # ~~Documentation:~~ [http://docs.python.org/devguide/docquality.html Documentation] # ~~Test coverage:~~ [http://docs.python.org/devguide/coverage.html Test coverage] If those sound interesting to you, look for issues in those areas. Next, for the office hours on Sunday, March 9th, we'll have a list of beginner-friendly bugs. Check back in here on Sunday to review that list. Finally, you can always ask for help or suggestions on the core-mentorship mailing list or in the <tt>#pyladies</tt> IRC channel. == Goal #4: submit a patch for a Python bug == [[File:Patch.png\|100px]] Follow the steps in the developer guide to create and submit a patch for your issue: http://docs.python.org/devguide/patch.html.▼ ▲Follow the steps in the developer guide to create and submit a patch for your ~~issue~~bug: http://docs.python.org/devguide/patch.html. Make sure to run the test suite first and that the tests all still pass! == Goal #5: start working on your application == [[File:Opw.png\|100px]] If you are a prospective GNOME Outreach Program for Women or Google Summer of Code intern, you're ready to start working on your application.