Looking to get the Mifos source code? You've come to the right place. Instructions on getting, and contributing to, the Mifos source code through our Git repository can be found below.

Effective use of version control is critical to effective team collaboration on Mifos. Our version control system is how we communicate code changes with one another.

...

Browse Source

• Summary/Tree (of the head repo only!)

Download a snapshot

• Download the latest code without version control
  • zip Zip archives (not release)

If you want to do download source code of some previous release then you should browse the repository and use "snapshot" link to download that code as a tar.gz archive.

Developer Setup

Follow Please follow this section completely before cloning any Mifos repositories!.

1. Install Git

...

The following sections outline how to install git on Windows, Ubuntu and the Mac OS:

Installing Git on Windows:

• Install msysGit (look for a file named similarly to Git-1.7.0.2-preview20100309.exe)
• select default components
• in "Adjusting your PATH environment" select "Run Git from the Windows Command Prompt"
• choose the default for the "Configuring the line ending conversions": "Checkout Windows-style, commit Unix-style line endings"

...

Installing Git on Ubuntu:

No Format
sudo apt-get install git-core

You may also find Step 4 of the Ubuntu install guide to be a handy reference.

...

Installing Git on Mac OS:

To install using macports, follow instructions here.

Alternately, an installer (.dmg) can be found at git's web site. (This .dmg file has been found to work just fine on Snow Leopard as well, despite being labeled as for Leopard.)

...

2. Configure Git line endings

Tell Git to handle line endings for you so folks on different platforms can live in harmony.

Configure line endings on Windows:

Do this on the Git Bash MINGW msysGit command line:

git config --global core.autocrlf true

Configure line endings on Linux

...

or Mac

...

Do thisOS:

git config --global core.autocrlf input

More

...

information on line endings is available at the following URLs:

• http://help.github.com/dealing-with-lineendings/
• http://article.gmane.org/gmane.comp.version-control.git/146485

3. Configure Git Author Info

To make all commits clear/legible/accessible, please configure git to use your full, real name and email.

This means...means user.name must be your real/legal first and last name. Do not abbreviate either. If you have more than two names, pick the two you are most commonly known by.

...

git config --global user.email joe@example.com

Day to day usage

For a quick summary, see the Git homepage.

Clone

...

4. Clone the codebase (read-only)

This is basically similar to a checkout operation - you'll get a read-only personal copy of the source code, which you can examine and modify .

For read-only access:

git clone git://github.com/mifos/REPOSITORY_NAME.git

Where REPOSITORY_NAME is "head", or as you like.

In the following example, we clone the "head" repository, but you can clone any of the repositories listed at https://github.com/mifoshttp://mifos.git.sf.net/  (also see below for tables explaining purposes of the various repositories). To clone the head repository: 

git clone git://github.com/mifos/head.git

Create an account on github. Read-write access uses a url, and permission granted by a current Mifos maintainer.

git@github.com:mifos/head.git

Which repository should I clone?

Active

...

repositories:

Archived/deprecated/old/inactive repositories:

Key-based auth

...

5. Fork the repository

To obtain a personal copy of the source code, which you can immediately commit to, head to Github (http://www.github.com/) and create an account there. You can fork the main Mifos repository by:

git clone git@github.com:username/head.git

Add the Mifos repository as the upstream repository (the repository the fork came from):

git remote add upstream git://github.com/mifos/head.git

If, whilst you've been inspecting the code or making changes, other commits have been made to the Mifos repository that you cloned, you can pull in upstream changes from the original repository with:

git fetch upstream

More help is available here: https://help.github.com/articles/fork-a-repo

6. Commit to

...

a local repository

Add files to the git "index" so they will be committed with "git add". Optionally, instead of running "git add", include -a when running "git commit" to commit all local modifications except new files. Then, commit:

...

In Git, the first 80 characters of the first line are, by convention, a summary of the rest of the log message. See Commit Log Guide.

7. Push your changes to a remote repository

If the remote repository is called "origin", you might do:

git push origin master

8. Update your master branch

git pull --rebase origin master

Using rebase is recommended to keep the commit history graph clean. Specifically, trivial merges cause a great deal of clutter. We may eventually institute a server side hook to prevent trivial merges.

9. Creating a patch

Instead of forking the Mifos repository you want to contribute to, you can create a patch. Here are two suggestions.:

1) Create an emailable (or JIRA-attachable) patch from your last local commit:

...

Either way, send the output to the mifos-developer mailing list, and describe your patch following Commit Log Guide.

You can also action the pull request via the Github user interface - just update the Mifos bug ticket with a helpful notification. For example:

Submitted in github pull request #x (pending).

Branching basics

Please refer to Pro Git: Basic Branching and Merging.

...