]> git.ipfire.org Git - thirdparty/freeswitch.git/commitdiff
Document how to setup git correctly
authorTravis Cross <tc@traviscross.com>
Fri, 12 Sep 2014 17:42:05 +0000 (17:42 +0000)
committerTravis Cross <tc@traviscross.com>
Fri, 12 Sep 2014 17:42:25 +0000 (17:42 +0000)
docs/SubmittingPatches

index 16be7a2479a12c8bb2f4edf242ce7b666de039e4..a7d2347aeb756617a9b6f0ad9564a087bb36ef41 100644 (file)
@@ -7,6 +7,13 @@ Download the Source Code
     git clone https://stash.freeswitch.org/scm/fs/freeswitch.git
     cd freeswitch
 
+Ensure Git is Setup
+-------------------
+
+    # tell git your full name and email address; make sure to use your
+    # real name and not a username
+    ./scripts/setup-git.sh
+
 Create Your Patch
 -----------------
 
@@ -24,6 +31,9 @@ Create Your Patch
     # logically separate change
     #while true; do emacs .; git commit -va; done
 
+    # review changes; ensure your author name is correct
+    git log -p
+
     # create patch files
     git format-patch origin/master..HEAD