======= Using Git for W-phase =======

===== How to use Git =====

Instead of repeating things that were said elsewhere, let us just give some pointers:
  * [[http://git-scm.com/download|Download Git]]
  * [[http://git-scm.com/|Git Community]]
  * [[http://schacon.github.com/git/user-manual.html|Git User Manual]]



===== Make sure your version of Git is OK =====

You need to have a version of Git greater or equal to 1.7.10, thus type:
<code>
git --version
</code>
and if the version number displayed is 1.7.10 or greater everything is OK, otherwise you need to install a more recent version.


===== One-time configuration for each repository =====

The W-phase package is hosted as a github repository. To clone the W-phase repository:
<code>
git clone https://github.com/eost/wphase.git wphase_package
</code>
If you have an error like 
<code>
error: The requested URL returned error: 403 while accessing https://github.com/eost/wphase.git/info/refs
</code>
please make sure to update git to version 1.7.10 or later (see above).

===== Regular daily usage: master branch (for regular users) =====

  * To update your local copy of the W-phase repository (pull changes from the master branch, i.e., stable version)
<code>
cd /to/the/wphase/directory/
git pull origin master
</code>


===== Regular daily usage: develop branch (for developers) =====

**If you would like to contribute or if you have any questions/suggestions, [[zacharie.duputel@unistra.fr,luis.rivera@unistra.fr|please contact us]].**

  * After cloning the repository, one may want to list existing branches
<code>
git branch -a
</code>

  * To update your local copy of the W-phase repository (pull changes from the develop branch)
<code>
git pull origin develop
* master
  remotes/origin/HEAD -> origin/master
  remotes/origin/develop
  remotes/origin/master
</code>
Notice the * character that prefixes the "master" branch: it indicates the branch that you currently have checked out. 

   * If you want to work on the develop branch, you can create a local version using:
<code>
git checkout -b develop origin/develop
</code>

   * To see the last commit on each local branch, you can run 
<code>
git branch -v
* develop 308999e Enable python3 compatibility in bin/traces_regional.py (...)
  master  2f33728 Correction numero de version -> r249
</code>

   * To switch from one branch to another
<code>
git checkout master
</code>
or
<code>
git checkout develop
</code>

   * make some changes to any file you want using your favorite editor (in the line below we use vi as an example)
<code>
vi some_file.c
</code>

   * You may want to check what has changed (and thus that will be committed), you can type one or both of these two commands:
<code>
git status
git diff
</code> 

   * To prepare the content staged for the next commit, use:
<code>
git add files_for_the_next_commit
</code> 

   * You can then commit staged changes locally, adding a short message (one line) explaining what you have changed
<code>
git commit -m "log message describing the changes"
</code> 

   * Before pushing the results, you can synchronise and see the local database using
<code>
git fetch origin
git branch -a
git branch -v
(etc...)
</code>

   * You can then push your changes to your GitHub fork
<code>
git push origin develop
</code> 

   * To merge develop into the master branch
<code>
git checkout master
git merge develop
</code> 

   * To create a new version tag, edit "Version: rXXX" in bin/Arguments.py and bin/RUNA3.csh. You should also add the corresponding tag using:
<code>
git tag -a rXXX -m "Short description of this release"
</code>

   * Listing the available tags in Git is straightforward. Just type
<code>
git tag
</code>

   * You can also see the tag data along with the commit that was tagged by using
<code>
git show r252
</code>
===== Configure ssh-keys for GitHub =====

https://help.github.com/articles/generating-ssh-keys