Github & Git

Introduction

This page describes how we use Git & Github. It is aimed at individuals and organisations who may wish to get/use the source code, or contribute back to the source code through the colloboration model.

We use Github & Git as we want:

• To simplify the way individuals and organisations can get access to the source code of our software.
• Allow individuals and organisations to independently make changes and extend the software for their own needs
• Allow individuals and organisations to easily contribute back any work they do through the Fork & Pull model.

Developers should follow the instructions below to make the above possible.

Fork the project on your personal or organisation github account.

If you dont have a github account already then you need to sign up and create one on on github.com (free accounts are fine).

Once you have a github account, the next step is to fork https://github.com/keithwoodlock/mifosx.

see https://help.github.com/articles/fork-a-repo for help on forking in github.

Install Git on your local machine

see Git pro book online for instructions for your operating system: http://git-scm.com/book/en/Getting-Started-Installing-Git

First time setup on your local machine

see Git pro book for what to do for first time setup: http://git-scm.com/book/en/Getting-Started-First-Time-Git-Setup

Of note is: $ git config --global user.name "John Doe" $ git config --global user.email johndoe@example.com