This is a work-in-progress guide intended to help those that need to use Windows as their developer environment. It will address whatever issues developers commonly face, with hints/tools that have been tested and are in use by other OPNFV developers.

===== Setting up Git and Gerrit =====

Source: Bryan Sullivan, AT&T

There are multiple ways to get git/gerrit working on Windows. Here are two:
  - Use Git for Windows
  - Run a linux under VirtualBox, and use the guides for Linux (TO BE DESCRIBED)

===== Using Git for Windows =====
This procedure will be clarified as needed and will be re-tested to make sure nothing is missing, superfluous, or redundant. Any input is appreciated.

  * Install Putty (the ZIP file or installer package) from http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
  * If you don't have a public/private key pair yet, run PuTTYgen and generate a pair
  * Start Pageant and import your private key ("Add Key")
  * Assuming you have already created a gerrit account for the project/org, add your public key to the account through the gerrit UI, e.g. https://gerrit.opnfv.org/gerrit/#/settings/ssh-keys
  * Install Git for Windows from http://www.git-scm.com/downloads
  * Run Git Bash. Further commands below are run in the git bash shell.
  * Create/edit your .bashrc file using vi or your editor. .bashrc sets up your bash environment when you run Git Bash
    * vi ~/.bashrc
      <code>
      #!/bin/bash
      PATH=$PATH:"/C/Program Files/Git/bin"
      eval `ssh-agent`
      # add my private key
      ssh-add (path to your private key, e.g. /c/files/my-key)
      # (optional) go to your git clone home dir
      cd (path to where you clone repos, e.g. /c/files/git) </code>
  * Run your .bashrc file, and enter the password to your private key file when prompted
      <code>
      source ~/.bashrc </code>
  * Create an ssh config file using vi or your editor.
    * vi ~/.ssh/config
      <code>
      Host (your git/gerrit host, e.g. opnfv.org)
        Hostname (your git/gerrit host, e.g. opnfv.org)
          User (your gerrit ID)
            IdentityFile (path to your private key, e.g. e.g. /c/files/my-key) </code>
  * Create/edit your .gitconfig file using vi or your editor.
    * vi ~/.gitconfig
      <code>
      [filter "lfs"]
        clean = git-lfs clean %f
        smudge = git-lfs smudge %f
        required = true
      [user]
        name = (your gerrit ID)
        email = (your email)
      </code>
  * If you are behind a corporate or other proxy, set the proxy in the git config
    <code>
    git config --global http.proxy (your proxy, e.g. http://proxy.example.com:8080)
    </code>
    * If you want to turn off the proxy (e.g. to use git outside your corporate network), edit the .gitconfig file and comment out the proxy line
      * vi ~/.gitconfig
      <code>
      [http]
      #       proxy = http://proxy.example.com:8080
      </code> 
  * Add your gerrit ID to your git config
    <code>
    git config --global --add gitreview.username "(your gerrit ID)"
    </code>
  * Copy the commit-msg hook to your git config
    <code>
    scp -p -P 29418 (your gerrit ID)@(your gerrit server domain, e.g. gerrit.example.com):hooks/commit-msg .git/hooks/
    </code>
  * If you do not have ssh access you can also get this via http
    <code>
    curl -Lo .git/hooks/commit-msg gerrit.opnfv.org/gerrit/tools/hooks/commit-msg
    chmod +x .git/hooks/commit-msg</code>
  * Install Python (3.5 or greater) per the "Windows" section of https://www.mediawiki.org/wiki/Gerrit/git-review
    * Select "Add to Path" option
    * Leave other options as-is, e.g. to ensure pip is installed also
  * Exit and re-enter git bash, to pick up the path changes made by the python installer
  * Install git-review per https://www.mediawiki.org/wiki/Gerrit/git-review
    <code>
    pip install git-review
    </code> 
  * Clone your repo using the "clone with commit-msg hook" URL provided in the gerrit project settings page, e.g. for the OPNFV "Copper" project at https://gerrit.opnfv.org/gerrit/#/admin/projects/copper
    <code>
    git clone https://gerrit.opnfv.org/gerrit/copper && scp -p -P 29418 \
      blsaws@gerrit.opnfv.org:hooks/commit-msg copper/.git/hooks/
    </code>  
  * Enter the cloned repo folder and setup git review
    <code>
    git review -s
    </code> 
  * If git review hangs, you might fix this by uninstalling and re-installing git (not sure why this helps, but it did at least once)

===== Creating a Commit and Gerrit Review =====

After making some changes in your repo clone:

  * Add the files you changed to the commit list
    <code>
    git add .
    </code>
  * Commit the changes and edit the commit-msg when vi opens
    <code>
    git commit --signoff --all
    (add commit description in first line, e.g. "Add DMZ deployment policy use case.")
    (add reference to JIRA issue in 3rd line, e.g. "JIRA: COPPER-3")
    (you should see that the --signoff option has resulted in a line being added e.g. \
    Signed-off-by: (your gerrit ID) <(your email)>
    </code>
  * Invoke git review
    <code>
    git review
    </code>