Warning

This documentation is for an old version of IPython. You can find docs for newer versions here.

Working with IPython source code

These pages describe a git and github workflow for the IPython project.

There are several different workflows here, for different ways of working with IPython.

This is not a comprehensive git reference, it’s just a workflow for our own project. It’s tailored to the github hosting service. You may well find better or quicker ways of getting stuff done with git, but these should get you started.

For general resources for learning git see git resources.

Contents:

• Install git
  • Overview
  • In detail
• Following the latest source
  • Get the local copy of the code
  • Updating the code
• Making a patch
  • Making patches
  • Moving from patching to development
• Git for development
  • Making your own copy (fork) of ipython
  • Set up your fork
  • Configure git
  • Development workflow
• git resources
  • Tutorials and summaries
  • Advanced git workflow
  • Manual pages online