Changes between Version 105 and Version 106 of DeveloperGuidelines/Git


Ignore:
Timestamp:
06/22/14 12:09:48 (7 years ago)
Author:
Michael Howden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/Git

    v105 v106  
    11= Git =
    22[[TOC]]
    3 Sahana Eden uses the Git DVCS & hosts active branches on [https://github.com GitHub]
     3Sahana Eden uses the Git Distributed Revision Control System (DRCS) & hosts active branches on [https://github.com GitHub]
    44== Developer Workflow ==
    5 === Fork the Sahana Eden Repository ===
     5=== Fork the Sahana Eden Repository on !GitHub & Locally ===
    66If you've not used !GitHub before:
    771. Sign-up for an account on [https://github.com GitHub]
    881. Set up git on you your computer by following [[http://help.github.com/set-up-git-redirect|these instructions]].[[BR]]
    9    Note: In order to contribute code back to the Eden project, you need to "push" your changes to !GitHub, and !GitHub
    10    requires you to authenticate for that. The instructions describe authenticating using a password. If you don't want
    11    to do do that, you can use SSH keys instead, but the [[https://help.github.com/articles/generating-ssh-keys|SSH setup]] is longer,
    12    and they do not provide instructions for Windows. If you're using Windows, you can follow
    13    [[https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair#Windows_.28PuTTY.29|these instructions]].
    14    They're for Launchpad, not !GitHub. The only difference is, while you're doing Step 5 (which has you copy the "OpenSSH" formatted
    15    public key to the clipboard), go over to the !GitHub instructions,
    16    to the "Add your SSH key to !GitHub" section. Ignore the Linux commands and do the part that saves your public key in your
    17    !GitHub account. (You should also save that public key in a local file.)
    18 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:
    19    {{{
    20 https://github.com/username/repository.git
    21 }}}
    22    If you're using ssh keys, then the address will be:
    23    {{{
    24 git@github.com/username/eden.git
    25 }}}
    26 1. There is [[https://help.github.com/|on-line help at GitHub]]
    27 
    28 Get your own copy of the Eden repository (repo) on both !GitHub and your local machine:
    29 1. Fork the Eden repo at: https://github.com/flavour/eden/fork
    30 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.)
     9 '''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]]
     101. 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
     111. Use git to {{{clone}}} your own new fork locally onto your computer:
     12'''User (Read Only):'''
    3113{{{
    3214cd web2py/applications
    33 git clone git@github.com:mygitusername/eden.git
     15git clone https://github.com/GITHUB_USERNAME/repository.git
     16}}}
     17'''Contributor (!Read/Write):'''
     18{{{
     19cd web2py/applications
     20git clone git@github.com:GITHUB_USERNAME/eden.git
     21}}}
     22
     235. 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.)
     246. Add Sahana Eden Trunk as a {{{remote}}} repository so that you can pull updates from it:
     25{{{
    3426cd eden
    3527git remote add upstream git@github.com:flavour/eden.git