Version 5 (modified by mrts, 7 years ago) (diff)


Collaboration on GitHub

This page gives guidelines for distributed Django development. It is not officially part of the Django development process.


1. Install git

If you want to learn more about git, see the git webpage or the git cheat sheet for a quick overview.


As of January 2009, the latest git release is 1.6.1. As there are many improvements compared with older releases (notably, a single executable), it is advisable to use this version instead of the ones provided in the Ubuntu release repositories. There is a personal package archive that provides git 1.6.1 backports to all Ubuntu releases since Hardy.

Installation instructions:

  1. add the following line to /etc/apt/sources.list (substituting UBUNTU_RELEASE_NAME with the Ubuntu release you are using):
  2. install git:
    $ apt-get update
    $ apt-get install git
  3. verify that the correct version was installed:
    $ git --version
    git version 1.6.1

2. Register an account on GitHub

Go to and follow the instructions.

Work process

The process should be managed with the Dictator and Lieutenants Workflow, described at

  • Dictators are core Django developers, who eventually merge the git branches back to Django trunk.
  • Lieutenants are developers, who take the responsibility of steering and coordinating the work on a large feature (e.g. aggregates).
  • Contributors are developers who contribute -- under lieutenant's guidance -- to the development of the feature.


  1. Create a fork of the automatically updated Django SVN trunk mirror on GitHub by clicking fork at
  2. Describe the design of the feature you implement on GitHub project wiki, list tasks that need tackling so that contributors get a clear overview and pick tasks easily.
  3. Clone the fork to your workstation:
    git clone
  4. Add the upstream Django SVN mirror for tracking:
    cd django
    git remote add upstream git://
    git fetch upstream
  5. Work on code, commit locally as needed:
    git commit -a -m "Implemented foo."
  6. Publish changes to your public repository:
    git push
  7. When the upstream Django SVN mirror is updated, pull the updates from it (fetching and merging in one step):
    git pull upstream master


Back to Top