Changes between Version 22 and Version 23 of CollaborateOnGithub

Timestamp:

Oct 6, 2009, 5:57:15 AM (15 years ago)

Author:

mrts

Comment:

Describe the branchy workflow. Please correct any errors or omissions.

CollaborateOnGithub

@@ -56 +56 @@
 Go to https://github.com/signup/free and follow the instructions.
 
+== Branchy development: working on several tasks in parallel ==
+
+You want to work on several fixes and features (tasks) and want to
+
+ * keep the changes for a particular task selt-contained in a branch,
+ * frequently update the codebase with upstream changes,
+ * have a has-it-all branch for testing out how the different task branches interact.
+
+=== Initial setup ===
+
+ 1. Create a fork of the automatically updated Django SVN trunk mirror on !GitHub by clicking ''fork'' at http://github.com/django/django/tree/master
+ 1. Clone the fork to your workstation:
+ {{{
+git clone git@github.com:YOUR_NICK_HERE/django.git
+ }}}
+ 1. Add the upstream Django SVN mirror for tracking:
+ {{{
+cd django
+git remote add upstream git://github.com/django/django.git
+git fetch upstream
+ }}}
+
+=== Working on a task ===
+
+'''Goal''': keep the changes self-contained, create and update patches suitable for attaching to [http://code.djangoproject.com/simpleticket tickets in Django trac].
+
+ 1. Create a branch from master
+ {{{
+git checkout -b ticket1234 master
+ }}}
+ 1. Change files, commit often
+{{{
+git commit -am "Changed foo."
+}}}
+ 1. [wiki:RunningDjangoTests Run tests]
+ 1. Create the remote branch and push changes into it
+ {{{
+git push origin ticket1234
+ }}}
+ 1. Create a patch, attach it to [http://code.djangoproject.com/simpleticket a relevant ticket in trac]
+ {{{
+git diff master > ticket1234.patch
+ }}}
+
+Repeat for every ticket you want to work on.
+
+=== After upstream has changed ===
+
+'''Goal''': bring in the changes in upstream to a task.
+
+ 1. When the upstream Django SVN mirror is updated, pull the updates from it (fetching and merging in one step)
+ {{{
+git pull upstream master
+ }}}
+ 1. Switch to the ticket branch
+ {{{
+git checkout ticket1234
+ }}}
+ 1. Merge, fix any conflicts
+ {{{
+git merge master
+ }}}
+ 1. [wiki:RunningDjangoTests Run tests]
+ 1. Push changes to GitHub (the remote branch was already created before)
+ {{{
+git push
+ }}}
+ 1. If the patch needs updating, create a new patch and attach it to the relevant ticket
+ {{{
+git diff master > ticket1234.patch
+ }}}
+
+Repeat for every ticket you have worked on.
+
+=== Testing everything in the has-it-all branch ===
+
+'''Goal''': a place to try out the code from several tasks together. `master` can not be used for this as it is used for tracking upstream. This is a temporary branch that can be removed after testing is done.
+
+ 1. Create the branch
+ {{{
+git checkout -b has-it-all master
+ }}}
+ 1. Merge in all task branches, fix any conflicts that occur in the task branches (i.e. they should merge cleanly)
+ {{{
+git merge ticket1234
+git merge ticket1235
+...
+ }}}
+ 1. [wiki:RunningDjangoTests Run tests]
+ 1. Delete the branch
+ {{{
+git checkout master
+git branch -d has-it-all
+ }}}
+
 == Collaboration on a large feature ==
 
@@ -63 +158 @@
  * ''Contributors'' are developers who contribute -- under lieutenant's guidance -- to the development of the feature.
 
+''The workflow described below should usually use a separate branch to the keep work isolated, so the instructions need updating.''
+
 === Lieutenant ===
 
@@ -118 +215 @@
 Largely, this is a copy-paste of the lieutenant workflow, only the tracked repositories and the final step (pull request) differ.
 
- 1. Create a fork of the lieutenant's repository on !GitHub by clicking ''fork'' at e.g. `http://github.com/LIEUTENANT_NICK_HERE/django/tree/master` (the URL may differ, obviously, LIEUTENANT_NICK_HERE is just a placeholder).
+ 1. Create a fork of the lieutenant's repository on !GitHub by clicking ''fork'' at e.g. `http://github.com/LIEUTENANT_NICK_HERE/django/tree/master`.
  1. Pick a task from the lieutenant's !GitHub project wiki, update the wiki as needed.
  1. Clone the fork to your workstation:
@@ -169 +266 @@
  1. Push changes to the public code hosting service 
  1. Update docs if needed
-
-== Working on single tickets ==