|Version 6 (modified by mrts, 8 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
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.
- add the following line to /etc/apt/sources.list (substituting UBUNTU_RELEASE_NAME with the Ubuntu release you are using):
deb http://ppa.launchpad.net/smartlounge/ubuntu UBUNTU_RELEASE_NAME main
- install git:
$ apt-get update $ apt-get install git
- verify that the correct version was installed:
$ git --version git version 1.6.1
2. Register an account on GitHub
Go to https://github.com/signup/free and follow the instructions.
The process should be managed with the Dictator and Lieutenants Workflow, described at http://whygitisbetterthanx.com/#any-workflow.
- 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.
- Create a fork of the automatically updated Django SVN trunk mirror on GitHub by clicking fork at http://github.com/django/django/tree/master
- 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 can pick tasks easily.
- Clone the fork to your workstation:
git clone firstname.lastname@example.org:YOUR_NICK_HERE/django.git
- Add the upstream Django SVN mirror for tracking:
cd django git remote add upstream git://github.com/django/django.git git fetch upstream
- Work on code, commit locally as needed:
git commit -a -m "Implemented foo."
- Publish changes to your public repository:
- When the upstream Django SVN mirror is updated, pull the updates from it (fetching and merging in one step):
git pull upstream master
- When the feature is ready, get in contact with a core developer to integrate your work.
Managing contributor submissions
When a contributor feels that his updates are ready to be merged back to lieutenant's repository, he should submit a pull request to the lieutenant (see below). When a lieutenant receives a pull request: