[IPython-dev] Gitwash: a git/github workflow document for review

Fernando Perez fperez.net@gmail....
Mon Apr 26 00:45:35 CDT 2010


On Sun, Apr 25, 2010 at 9:11 PM, Brian Granger <ellisonbg@gmail.com> wrote:

> A nice lightweight way for dev's to contribute code is to use git
> format-patch.  I like how Sympy encourages contributions using this
> approach as it is super easy.

Ah, thanks for that.  I've never used it before, do you have a
reference from the sympy guys on how they guide new users in this
direction?  We can just copy theirs.

> Also, I think for a new
> user, it will be confusing that the docs are about gitwash rather than
> ipython or nipy.  Sorry if this is a bit pessimistic.

Oh, the name 'gitwash' was precisely so Matthew could draft something,
and then we could do a search and replace and put ipython in there :)

We do want it to be a copy/paste worksheet, most definitely, and 100%
specific to getting started for ipython and nipy.  Ideally we can use
the same workflow for both, but eventually this will be pasted into
each project's doc tree and used with project-specific urls, names,

So think of 'ipython' wherever you read 'gitwash' and critique away as
something we'll want for IPython itself.  The gitwash repo is just a
drafting/staging place to get the doc ready to move into nipy and
ipython. Hopefully we can get it in decent shape first, before each
project takes it and makes it specific to each workflow.

And we completely agree that we do *not* want it to become a
'book-lite'.  There are plenty of great tutorials with concepts,
pictures, etc. for that.  We just want it to be the 'tell me what to
copy/paste to get started with IPython/nipy' worksheet.



More information about the IPython-dev mailing list