annotate README.txt @ 5:0bfbd062765d

add a README
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 21 Jul 2010 13:49:46 -0700
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 gut
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2 ===
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 gut is a particular workflow for github. It works like this:
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 0. It assumes you've already cloned the master repo
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 1. Use `gut feature <name>` to create the feature branch you care
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9 about. For systems with bug numbers, it is recommended to create a
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
10 branch with the bug number name (e.g. `gut feature bug-123456`)
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 2. Do your development. Use git like you normally would during a
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
13 normal development cycle for commiting, etc.
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
14
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
15 3. When it comes time to make a patch, run `gut patch`. This will
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
16 generate a .diff file based on your feature branch name and output a
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
17 combined log for the branch to the console.
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
18
0bfbd062765d add a README
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
19 4. Apply the patch to the master and push it.