Changes between Version 48 and Version 49 of DeveloperGuidelines/Git

Timestamp:

05/18/12 05:25:07 (13 years ago)

Author:

Fran Boon

Comment:

Simpler workflow option without story branch

DeveloperGuidelines/Git

@@ -20 +20 @@
 https://docs.google.com/drawings/d/1TppJKr9Qrq6I2KpkljRixx5gYh1seRqCXk8KDWdeIF0/edit
 === Ongoing Coding ===
-We suggest adopting the [http://blog.hasmanythrough.com/2008/12/18/agile-git-and-the-story-branch-pattern Story Branch] pattern, which allows squashing commits in order to keep the main Trunk as clean as possible
-{{{
-cd <mydirectory>
-
-# Set github.com/flavour/eden as the upstream repository
-git remote add upstream git://github.com/flavour/eden.git
+{{{
+cd web2py/applications/eden
 
 # Update your working directory with latest code from Trunk
-git fetch upstream
-git merge upstream/master
-git checkout -b <mystory>
+git pull upstream
 
 # Write Code
+
+# Quick review of code (no test code left in, etc)
+git diff
+
+# Check for any new files which need adding
+git status
+git add.
+
+# Commit Code (Note, no pushes to GitHub here)
 git commit -am "My Story: Part 1"
 .
@@ -39 +42 @@
 git commit -am "My Story: Part N"
 
+# Merge latest Trunk
+git pull upstream
+
+# Resolve any conflicts (see below for how)
+
+# Commit fixed code
+git add .
+git commit -a
+
+# Squash commits to as few as possible to keep revision history clean & make it easier to review the work
+git rebase -i
+
+# Push to your branch on GitHub
+git push
+}}}
+
+[[Image(https://docs.google.com/drawings/pub?id=1Vhvm1EmqWOVNZkZsiJ0MLLpdTl6H_ya263Tdb2HK1N0&w=960&h=720)]]
+https://docs.google.com/drawings/d/1Vhvm1EmqWOVNZkZsiJ0MLLpdTl6H_ya263Tdb2HK1N0/edit
+
+Once you have pushed to your branch on GitHub, you will likely want this to be merged with Trunk - this should be done via a Pull Request. This is done on GitHub:
+* https://github.com/mygitusername/eden/pull/new/<mystory>(the branch name)
+
+[[Image(https://docs.google.com/drawings/pub?id=1QmGeuQvFpg3pDQpM9xu81V7MlVy4uU8EzVIRqQ14MwU&w=792&h=353)]]
+https://docs.google.com/drawings/d/1QmGeuQvFpg3pDQpM9xu81V7MlVy4uU8EzVIRqQ14MwU/edit
+
+If you want to adopt the [http://blog.hasmanythrough.com/2008/12/18/agile-git-and-the-story-branch-pattern Story Branch] pattern, which allows pushing interim work to GitHub for review & also allowing contributing quick fixes to Trunk without needing to complete the interim work:
+{{{
+git checkout -b <mystory>
+
+git commit -a
+...
+git commit -a
+
 # Quick review of code (no test code left in, etc)
 git diff master...HEAD
-
-# Merge latest Trunk
-git fetch upstream
-git merge upstream/master
-
-# Squash commits to as few as possible to keep revision history clean & make it easier to review the work
-git rebase -i
-
-# One more method to squash your commits if they are not in between two executions of git pull or git merge is:
+}}}
+
+One more method to squash your commits if they are not in between two executions of git pull or git merge is:
+{{{
 git stash
 git reset HEAD@{N}
 git commit -am 'Your commit message for the one-big-commit'
-git push upstream HEAD(or your-branch/tag-name)
+git push
 git stash pop
-
-}}}
-
-[[Image(https://docs.google.com/drawings/pub?id=1Vhvm1EmqWOVNZkZsiJ0MLLpdTl6H_ya263Tdb2HK1N0&w=960&h=720)]]
-https://docs.google.com/drawings/d/1Vhvm1EmqWOVNZkZsiJ0MLLpdTl6H_ya263Tdb2HK1N0/edit
-
-Once you have pushed to your branch on GitHub, you will likely want this to be merged with Trunk - this should be done via a Pull Request. This is done on GitHub:
-* https://github.com/mygitusername/eden/pull/new/<mystory>(the branch name)
-
-[[Image(https://docs.google.com/drawings/pub?id=1QmGeuQvFpg3pDQpM9xu81V7MlVy4uU8EzVIRqQ14MwU&w=792&h=353)]]
-https://docs.google.com/drawings/d/1QmGeuQvFpg3pDQpM9xu81V7MlVy4uU8EzVIRqQ14MwU/edit
-
+}}}
 ==== Resolving Merge Conflicts ====
 If you encounter conflicts during the rebase, the conflicts will be tagged in the files with: