Differences between revisions 4 and 36 (spanning 32 versions)
⇤ ← Revision 4 as of 2012-04-18 21:19:11 →
Size: 3096
Editor: 199
Comment: bold and code
← Revision 36 as of 2012-05-12 22:31:47 → ⇥
Size: 4139
Editor: IP-173-231-109-154
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= Participating to a Distutils2 Sprint =

== Before: Getting Set up ==
Line 3: Line 7:
 * Install '''Python''' 2.5, 2.6 or 2.7. If your operating system has a package manager, use it (and also install a python2.7-devel or python2.7-dev package if it exists), otherwise follow the instructions on http://python.org/download/  * Install '''Python''' 2.5, 2.6 or 2.7 (recommended). If your operating system has a package manager, use it (and also install a python2.y-devel or python2.y-dev package if it exists), otherwise follow the [[http://python.org/download/|instructions]].
Line 5: Line 9:
 * Install '''Mercurial'''. Instructions are on http://hg-scm.org/downloads/ or http://tortoisehg.bitbucket.org/download/ if you are using Windows. If you have never used it, read http://hginit.com/01.html and http://hginit.com/02.html  * Install '''Mercurial'''. If needed, read [[http://hg-scm.org/downloads/|instructions]] (or [[http://tortoisehg.bitbucket.org/download/|Windows instructions]]). If you have never used it, read [[http://hginit.com/01.html|Ground up Mercurial]] and [[http://hginit.com/02.html|Setting up for a Team]].
Line 7: Line 11:
 * If you don’t have '''TortoiseHg''', you need to install a '''merge tool''': see http://mercurial.selenic.com/wiki/MergeProgram  * If you don't have '''!TortoiseHg''', you need to install a [[http://mercurial.selenic.com/wiki/MergeProgram|merge tool]].
Line 9: Line 13:
 * Install '''unittest2''' and '''docutils''', they are needed to run the tests for Distutils2. If your package manager has them, use it; if you use virtualenv, you know how to install them; otherwise, you will need to download them from the Python Packages Index, unpack the archives and install them with the command {{{python setup.py install --user}}}.  
  * unittest2: http://pypi.python.org/pypi/unittest2
  * docutils: http://pypi.python.org/pypi/docutils		  * Install '''[[http://pypi.python.org/pypi/unittest2|unittest2]]''' and '''[[http://pypi.python.org/pypi/docutils|docutils]]''', they are needed to run the tests for Distutils2. If your package manager has them, use it; if you use virtualenv, you know how to install them; otherwise, you will need to download them from the Python Packages Index, unpack the archives and install them with the command {{{python setup.py install --user}}}.
Line 14: Line 17:
 * Mercurial requires a bit of '''configuration''' before you can use it. You need to define a user name (in the form “Name <email@address>”) in a configuration file; see http://mercurial.aragost.com/kick-start/en/basic/#installation-configuration for more information.  Some very useful features of Mercurial can also be enabled in the same config file; this page will be edited later with examples or we'll do it at the start of the sprint.  * Mercurial requires a bit of '''configuration''' before you can use it. You need to define a user name (in the form “Name <email@address>”) in a [[http://mercurial.aragost.com/kick-start/en/basic/#installation-configuration|configuration file]]. Some very useful features of Mercurial can also be enabled in the same config file; this page will be edited later with examples or we'll do it at the start of the sprint.
Line 16: Line 19:
 * You can now get a clone of the '''Distutils2''' repository. Open a terminal or command prompt and type this: {{{hg clone https://bitbucket.org/python_mirrors/distutils2}}}
You can also use the “Fork” button on the Bitbucket website to create a long-lived clone if you think you will contribute after the sprint.		  * You can now get a '''clone''' of the Distutils2 repository. Open a terminal or command prompt and type this: {{{hg clone https://bitbucket.org/mtlpython/distutils2}}} . When you have a changeset ready to push, just ask someone of the team to add your account to the repository’s members.
Line 19: Line 21:
The list of bugs suitable for a sprint is here: http://bugs.python.org/issue?%40search_text=&ignore=file%3Acontent&title=&%40columns=title&id=&%40columns=id&stage=&creation=&creator=&activity=&%40columns=activity&%40sort=activity&actor=&nosy=&type=&components=25&versions=&dependencies=&assignee=&keywords=6&priority=&%40group=priority&status=1&%40columns=status&resolution=&nosy_count=&message_count=&%40pagesize=50&%40startwith=0&%40queryname=&%40old-queryname=&%40action=search You can have a look if you are curious, but not all bugs clearly describe what the problem is or how we may fix it. At the beginning of the sprint we will explain quickly what Distutils2 does, how it works and how to fix bugs. A legal note: Because Distutils2 is distributed by the Python Software Foundation under the Python license, you will have to sign a '''contributor agreement''' to allow the PSF to redistribute your code. You can read and prepare [[http://www.python.org/psf/contrib/|the agreement]] before the sprint, or use one of the copies we will have with us.
Line 21: Line 23:
Finally, a legal note: Because Distutils2 is distributed by the Python Software Foundation under the Python license, you will have to sign a contributor agreement to allow the PSF to redistribute your code. You can read and prepare the agreement before the sprint (http://www.python.org/psf/contrib/), or use one of the copies we will have with us. == During: Finding a Bug or Feature to Work on ==

At the beginning of the sprint we will explain quickly what Distutils2 does, how it works and how to fix bugs. These are the bugs that can be tackled by someone new to the codebase; please add your name when you choose one to avoid work duplication.

 * http://bugs.python.org/issue12944
 * --( http://bugs.python.org/issue13614 )-- [PP et mlhamel]
 * http://bugs.python.org/issue13399 [Patrice]
 * http://bugs.python.org/issue13331 [Denis]
 * http://bugs.python.org/issue13400 (two patches needed)
 * http://bugs.python.org/issue6114 (Rory was interested)
 * http://bugs.python.org/issue13317 [Patrice]
 * --( http://bugs.python.org/issue10374 )-- [PP]
 * http://bugs.python.org/issue7677 [Kim]
 * http://bugs.python.org/issue1222585
 * http://bugs.python.org/issue5342 [Jonathan]
 * http://bugs.python.org/issue13400 [Julien]
 * http://bugs.python.org/issue763043 needs a doc patch; talk with merwok about that
 * http://bugs.python.org/issue5300
 * http://bugs.python.org/issue8501 needs tests
 * http://bugs.python.org/issue809163 has a patch which needs a test and a review
 * http://bugs.python.org/issue14270 [mlhamel]

If a report does not clearly describe what the problem is or how we may fix it, just ask.

== After: Staying in Touch ==

If your patch is not finished at the end of the sprint, or if you want to work on another thing, you can use the bug tracker or the montreal-python mailing list to ask questions and send patches. The best place is the bug tracker; it only requires creating a user account and keeps a record of the problems found and choices made during development.

Participating to a Distutils2 Sprint

Before: Getting Set up

To get ready for a Distutils2 sprint, you need to complete these steps:

  • Install Python 2.5, 2.6 or 2.7 (recommended). If your operating system has a package manager, use it (and also install a python2.y-devel or python2.y-dev package if it exists), otherwise follow the instructions.

  • Install Mercurial. If needed, read instructions (or Windows instructions). If you have never used it, read Ground up Mercurial and Setting up for a Team.

  • If you don't have TortoiseHg, you need to install a merge tool.

  • Install unittest2 and docutils, they are needed to run the tests for Distutils2. If your package manager has them, use it; if you use virtualenv, you know how to install them; otherwise, you will need to download them from the Python Packages Index, unpack the archives and install them with the command python setup.py install --user. On the sprint day we will have copies of the zip/tar files on USB sticks for your convenience.

  • Mercurial requires a bit of configuration before you can use it. You need to define a user name (in the form “Name <email@address>”) in a configuration file. Some very useful features of Mercurial can also be enabled in the same config file; this page will be edited later with examples or we'll do it at the start of the sprint.

  • You can now get a clone of the Distutils2 repository. Open a terminal or command prompt and type this: hg clone https://bitbucket.org/mtlpython/distutils2 . When you have a changeset ready to push, just ask someone of the team to add your account to the repository’s members.

A legal note: Because Distutils2 is distributed by the Python Software Foundation under the Python license, you will have to sign a contributor agreement to allow the PSF to redistribute your code. You can read and prepare the agreement before the sprint, or use one of the copies we will have with us.

During: Finding a Bug or Feature to Work on

At the beginning of the sprint we will explain quickly what Distutils2 does, how it works and how to fix bugs. These are the bugs that can be tackled by someone new to the codebase; please add your name when you choose one to avoid work duplication.

If a report does not clearly describe what the problem is or how we may fix it, just ask.

After: Staying in Touch

If your patch is not finished at the end of the sprint, or if you want to work on another thing, you can use the bug tracker or the montreal-python mailing list to ask questions and send patches. The best place is the bug tracker; it only requires creating a user account and keeps a record of the problems found and choices made during development.

Distutils2/Sprints (last edited 2012-05-12 22:31:47 by IP-173-231-109-154)

Unable to edit the page? See the FrontPage for instructions.