Changes between Version 105 and Version 106 of DeveloperGuidelines/Git

Timestamp:

06/22/14 12:09:48 (11 years ago)

Author:

Michael Howden

Comment:

--

DeveloperGuidelines/Git

@@ -1 +1 @@
 = Git =
 [[TOC]]
-Sahana Eden uses the Git DVCS & hosts active branches on [https://github.com GitHub]
+Sahana Eden uses the Git Distributed Revision Control System (DRCS) & hosts active branches on [https://github.com GitHub]
 == Developer Workflow ==
-=== Fork the Sahana Eden Repository ===
+=== Fork the Sahana Eden Repository on !GitHub & Locally ===
 If you've not used !GitHub before:
 1. Sign-up for an account on [https://github.com GitHub]
 1. Set up git on you your computer by following [[http://help.github.com/set-up-git-redirect|these instructions]].[[BR]]
-   Note: In order to contribute code back to the Eden project, you need to "push" your changes to !GitHub, and !GitHub
-   requires you to authenticate for that. The instructions describe authenticating using a password. If you don't want
-   to do do that, you can use SSH keys instead, but the [[https://help.github.com/articles/generating-ssh-keys|SSH setup]] is longer,
-   and they do not provide instructions for Windows. If you're using Windows, you can follow
-   [[https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair#Windows_.28PuTTY.29|these instructions]].
-   They're for Launchpad, not !GitHub. The only difference is, while you're doing Step 5 (which has you copy the "OpenSSH" formatted
-   public key to the clipboard), go over to the !GitHub instructions,
-   to the "Add your SSH key to !GitHub" section. Ignore the Linux commands and do the part that saves your public key in your
-   !GitHub account. (You should also save that public key in a local file.)
-1. The way you refer to repositories on !GitHub in git commands in differs depending which method you're using to authenticate to !GitHub. If you are using a password, then the address of a repository has the form:
-   {{{
-https://github.com/username/repository.git
-}}}
-   If you're using ssh keys, then the address will be:
-   {{{
-git@github.com/username/eden.git
-}}}
-1. There is [[https://help.github.com/|on-line help at GitHub]]
-
-Get your own copy of the Eden repository (repo) on both !GitHub and your local machine:
-1. Fork the Eden repo at: https://github.com/flavour/eden/fork
-1. Use git to clone your own new fork down to your PC. (Use the appropriate address form depending on whether you're using a password or ssh keys, and substitute your own !GitHub username.)
+ '''Contributor (!Read/Write):''' You need to clone !GitHub repositories using SSH to allow you to {{{push}}} your changes back to !GitHub to contribute to the Sahana Eden project. To do this follow the [[https://help.github.com/articles/generating-ssh-keys| Generatin SSH Keys]] [[BR]]
+1. Fork the Sahana Eden Trunk repository at: https://github.com/flavour/eden/fork to get your own copy of the Eden repository (repo) on both !GitHub 
+1. Use git to {{{clone}}} your own new fork locally onto your computer:
+'''User (Read Only):'''
 {{{
 cd web2py/applications
-git clone git@github.com:mygitusername/eden.git
+git clone https://github.com/GITHUB_USERNAME/repository.git
+}}}
+'''Contributor (!Read/Write):'''
+{{{
+cd web2py/applications
+git clone git@github.com:GITHUB_USERNAME/eden.git
+}}}
+
+5. Use git to clone your own new fork down to your PC. (Use the appropriate address form depending on whether you're using a password or ssh keys, and substitute your own !GitHub username.)
+6. Add Sahana Eden Trunk as a {{{remote}}} repository so that you can pull updates from it:
+{{{
 cd eden
 git remote add upstream git@github.com:flavour/eden.git