Changes between Version 41 and Version 42 of DeveloperGuidelines/Git

Timestamp:

04/12/12 21:35:59 (13 years ago)

Author:

g0wda

Comment:

Inadvertently moved up stuff from alternative workflow I think removed the use of git pull because git fetch and git merge together will help us point out errors better.

DeveloperGuidelines/Git

@@ -5 +5 @@
 === Fork a fresh Branch ===
 * Sign-up for an account on [https://github.com GitHub]
-  * So that you can contribute code back to the project you will need an SSH public key. There is on-line help at github (select Beginner - Set Up Git and then scroll down to Set Up SSH Keys) 
 * Fork the Eden Branch: https://github.com/flavour/eden/fork_select
 * Use Git to clone this down to your PC:
+
+Note: (So that you can contribute code back to the project) If you want to use SSH to push your changes to the code back to Github, you will need an SSH public key. There is on-line help at github (select Beginner - Set Up Git and then scroll down to Set Up SSH Keys) [1]
 {{{
 cd web2py/applications
@@ -18 +19 @@
 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 <mybranch>
+cd <mydirectory>
+
+# Set github.com/flavour/eden as the upstream repository
+git remote add upstream git://github.com/flavour/eden.git
+
 # Update your working directory with latest code from Trunk
-git pull upstream master
+git fetch upstream
+git merge upstream/master
 git checkout -b <mystory>
+
 # Write Code
-git commit -am "My Story"
+git commit -am "My Story: Part 1"
+.
+.
+.
+git commit -am "My Story: Part N"
+
 # Quick review of code (no test code left in, etc)
-git diff master
+git diff master...HEAD
+
 # Merge latest Trunk
-git checkout master
-git pull # to get any merges, pulls or edits which you may have done on your GitHub branch
-git pull upstream master
-git checkout <mystory>
+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 master
-# Push to your branch on GitHub
-git checkout master
-git merge <mystory>
-git push
-# Cleanup
-git branch -d <mystory>
+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:
+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 stash pop
+
 }}}
 
 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/master
-
-==== Squashing Commits ====
-If you didn't squash your commits before submitting the Pull Request, you may be asked to do so so that the pull request contains a single commit which is easy to review & applies cleanly.
-
-This isn't directly possible once your code is Pushed.
-
-Option 1:
-{{{
-git stash
-git checkout -b newbranch
-# Add an extra tilde per commit to squash (this assumes 2 commits)
-git reset HEAD~~
-git commit -am 'Sqashed!'
-}}}
-
-Option2: [[BR]]
-Create a patch & apply this to a clean clone.
+* https://github.com/mygitusername/eden/pull/new/<mystory>(the branch name)
 
 ==== Resolving Merge Conflicts ====
@@ -113 +110 @@
 }}}
 
+=== Resetting to a previous commit ===
+There are two types of resets soft and hard.
+A soft reset is done like this:
+{{{
+git reset --soft HEAD@{N}
+}}}
+This resets your branch N previous commits (to a commit at a distance N from HEAD, the latest commit) but only in terms of git history. Hence your code remains untouched by git in a soft reset.
+
+A hard reset is done using:
+{{{
+git reset --soft HEAD@{N}
+}}}
+This resets your branch N previous commits removing both history and changes to the file ever since.
+ 
 === Creating a 2nd branch ===
 If you wish to have multiple separate branches to work on, you can run these as separate web2py applications