Have you implemented OpenMRS? Please participate in the Implementation Site Survey. If you already have, thank you!
Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Change header of "Work on your task" so as it is not a child of previous header.


Table of Contents

Install Git on your computer

To get the git binary, see OS specific sections on installing git page.

This gives you a git command line. Git at the command line is easier to use in some instances than IDE Integration. But if you want
to use your IDE to interact with git (ala subclipse in eclipse), then see Git IDE Integration.

If you are a Windows user, see how to setup your user and password for the git command line here.

Get the code (with the intention of contributing changes)

These instructions are designated for a developer who wants to contribute to projects under https://github.com/openmrs. A private fork will be used only as a backup storage and for pull requests, but not for collaboration with other developers. If you intend to use your fork to work in a team, please make necessary adjustments to the proposed workflow by avoiding the use of rebase.

Create account on github.com

https://github.com/signup/free

Tip

Looking for a quick reference to git commands?  Check out the Git for SVN Users page.

Info

We switched OpenMRS core/trunk code from svn to git. As of August 2012 we are using github.com as the hosting provider for our git projects. See the openmrs github organization.

Check out the code to your machine

  1. On github.com, fork a project you want to work on (see tutorial: http://help.github.com/fork-a-repo).
  2. Clone the fork to your local machine (replace "yourusername"):

    Code Block
    git clone https://github.com/yourusername/openmrs-core.git
  3. Go into the folder just created and set up the "upstream" remote so you can eventually pull changes from the main repository (see "Configure Remotes" on http://help.github.com/fork-a-repo):

    Code Block
    git remote add upstream https://github.com/openmrs/openmrs-core.git
  4. Fetch and track all branches on remote repositories.

    Code Block
    git fetch --all
  5. After you cloned the repository you can list available branches:

    Code Block
    git branch -a

    The currently checked out branch is highlighted with an asterisks. The master branch is the latest development branch (trunk was its counterpart in SVN).

  6. Pull changes from the upstream remote:

    Code Block
    git pull --rebase upstream master

    The '--rebase' option reverts any of your commits which are not in upstream/master, then fast forwards your local branch to upstream/master and finally applies your commits on top of that. This allows you to avoid merge commits and keep the history linear, but must not be used if you want others to work with you on a branch in your fork.

    Info

    Optional pro tip: To save some key hits we recommend to setup an alias for 'pull --rebase' by running

    Code Block
    git config --global alias.up "pull --rebase"

    From now on you will be able to use 'git up upstream master' instead of 'git pull --rebase upstream master'.

  7. Push changes to your fork on github:

    Code Block
    git push

    This command pushes all your commits from all your tracked branches to your fork. If your fork has commits, which are not in your local repository, the branches containing these commits will not be pushed. You will need to pull on these branches first to have them pushed.

 

Note

We do not advise you to work on master or maintenance branches of openmrs-core, but create topic branches instead. This way you will be able to send us pull requests to merge your code back to the main repository. See "Create Topic Branches" below, please take a look at our pull requests tips page.

See Maven wiki page for how to build, compile, etc.

Get the code in ready-only mode (without intention of contributing)

This will check out the code for "openmrs-core" (the core OpenMRS application):

Code Block
git clone https://github.com/openmrs/openmrs-core.git

 

  1. Checkout out a new local branch based on your master and update it to the latest. The convention is to name the branch after the current ticket e.g. TRUNK-123. 

    Warning

    Make sure you have committed any new files that are not under version control otherwise you will lose them when you run *git clean -df*

    Code Block
    git checkout -b TRUNK-123 master
    git clean -df
    git pull --rebase upstream master
  2. Push the branch to your fork. Treat it as a backup.

    Code Block
    git push origin TRUNK-123
    Info

    Pro tip! Git has tab completion here!

Work on your task

NOTE: If the ticket you are working on requires you to work off a development branch say 1.9.x, you will have to use the development branch name instead of master for the instructions in this section. E.g. instead of git pull --rebase upstream master you will run git pull --rebase upstream 1.9.x, where 1.9.x is the development branch you are coding off.

  1. Make changes in code.
  2. Add changes to a commit (stage them). To see what files have changed.

    Code Block
    git status

    To stage all changed and new files.

    Code Block
    git add -A

    To pick only some files.

    Code Block
    git add -i

    You will see a summary of changed and new files. You need to choose '2' to mark files as updated. Now you need to pick files, which you want to mark as updated. You can specify them as a list 1, 2, 3, as a range 1-3, or simply * to select all. Confirm by hitting the enter key twice. If there are new (untracked) files, choose '4' and pick files the same way. Choose '7' to quit.

  3. Commit changes.

    Code Block
    git commit -m "TRUNK-123: Put change summary here (can be a ticket title)"

    Please remember to specify the current ticket id in your commit message. 
    Optionally run mvn install -DskipTests=true before your commits so that the formatting is fixed.

  4. If you need to take a break from your work and continue later, you should backup your code by committing changes and pushing to your fork.

    Code Block
    git push origin TRUNK-123
    Warning

    If you absolutely need to and you know what you are doing, add the '-f' option to force the push, which means overwriting history if necessary. You must NEVER use this option with the main repository (upstream: https://github.com/openmrs (https://github.com/openmrs\! ))!

  5. Before you pick up your work again, update to the latest code.

    Code Block
    git pull --rebase upstream master

    If you have uncommitted changes and git refuses to merge, you can stash your changes, perform a pull and then unstash them.

    Code Block
    git stash
    git pull --rebase upstream master
    git stash pop

    If you have conflicts, you need to resolve them by editing conflicting files, adding them to index, committing and then pulling again. Alternately you could try with a different merge strategy.

    Code Block
    git pull --rebase -X patience upstream master
    Info

    If you want to nuke all your commits run 'git reset --hard upstream master'. If you want to nuke only last commit run 'git reset --hard HEAD~1'.

Submit the code

  1. Update your branch to the latest code.

    Code Block
    git pull --rebase upstream master
  2. If you have made many commits, we ask you to squash them into atomic units of work. Most of tickets should have one commit only, especially bug fixes, which makes them easier to back port.

    Code Block
    git checkout master
    git pull --rebase upstream master
    git checkout TRUNK-123
    git rebase -i master

    See Git Rebasing.

  3. Make sure all unit tests still pass

    Code Block
    mvn clean package
  4. Push changes to your fork

    Code Block
    git push -f
  5. On github.com, submit a "pull request" to the main repo. (About pull requests: http://help.github.com/send-pull-requests/)
  6. On the ticket, click the "Request Review" button and add a comment linking to the url of the pull request.

Synchronizing with EGit

if you are using EGit, you may need to synchronize the changes you made on your local copy against either your fork or your remote master copy (upstream).

To compare with upstream:

  1. Right-click on the module to compare
  2. Select 'compare with'
  3. Select 'Branch / tag or reference'
  4. Select 'Remote tracking'
  5. Select 'Upstream/master'

To compare your changes against your fork (origin),

  1. Right-click on the module to compare
  2. Select 'compare with'
  3. Select 'Head Revision'

Getting feedback on a pull request and making changes to it

After you requested a code review you need to wait for a full committer to look at your work and either merge your changes or ask for improvements. We are doing our best so that it does no take longer than a few days for you to get feedback.

Reviews are normally done in github as comments on your pull request (see https://github.com/openmrs/openmrs-core/pull/93 for example). You can see all comments on the discussion tab. If you did follow up commits, some comments may be hidden and you just need to click 'Show outdated diff' to see them. When a reviewer has finished commenting on the pull request, the ticket will be moved to the 'Rework Needed', 'Committed Code' or 'Closed' stage. If it is 'Committed Code' or 'Closed', your work has been merged, the pull request closed and your job is done.

In order to make improvements you just need to commit to the same branch you created for the pull request and push to your fork. Github will automatically detect new commits and add them to your pull request. After you have made all improvements you need to move the ticket back to the 'Request Review' stage. The reviewer will be automatically notified to look at your code again.

Sometimes it may take a few rounds of reviews for the code to be ready so do not be discouraged. It is our common effort to keep good quality of code.

After the ticket has been closed

  • After your pull request has been accepted, the ticket is closed, and you have no further need of the branch you created, you can clean things up by deleting it from your local repository and your fork:

    Code Block
    git branch -D TRUNK-123
    git push origin :TRUNK-123

Creating your own module on github

(TODO, link to place in the "Creating Modules" hierarchy instead?)
The OpenMRS organization on GitHub (http://github.com/openmrs) can be used to host community OpenMRS projects. All bundled modules managed within git are kept under this organization with the naming convention "openmrs-module-<moduleid>".  All community-supportes modules are welcome and encouraged to be kept under the OpenMRS organization as well.

Other organizations and authors can maintain OpenMRS modules under other accounts within github but are encouraged to use the same naming convention "openmrs-module-moduleid" naming convention.

  1. Create the remote repository, and get the URL such as:  https://github.com/openmrs/openmrs-module-appointment.git
  2. Locally, at the root directory of your module's source, git init
  3. Locally, add and commit what you want in your initial repo (for everything, git add . )
  4. git commit -m 'adding module to repository'
  5. To attach your remote repository with the name 'origin' (like cloning would do),  git remote add origin URL From Step 1, for example:
    git remote add origin https://github.com/openmrs/openmrs-module-appointment.git
  6. git pull origin master
  7. git push origin master

Naming Conventions

When using Git for your project, please use the following naming conventions:

  • Use all lowercase.
  • Please include "OpenMRS module", "OpenMRS Contrib", or "OpenMRS Distro" somewhere in your project's README.

For modules

  • Use the name "openmrs-module-moduleid" (for example: openmrs-module-htmlformentry)

For scripts that package a distribution

  • Use the name "openmrs-distro-xyz" (for example: openmrs-distro-referenceapplication)

For variations of the OpenMRS Standalone

  • Use the name "openmrs-standalone-xyz"

For other contributions

  • Use the name "openmrs-contrib-contribname" (for example: openmrs-contrib-atlas).

 

Note

When creating a new module or contrib, please e-mail code@openmrs.org to request a module ID or contribution name, including your OpenMRS ID, a description of your module/contribution, and your proposed module ID or contribname.  The conversation with the "code" e-mail group is used to avoid duplicates and maximize consistency of naming; you should expect a module ID to be decided within one day of your request.  Eventually, we hope to create a more automated process for ensuring uniqueness of module identification & awareness of existing modules.

 

Why Github?

Github is currently the largest git hosting repository available. We want to join the community of developers there as well as eliminate another headache of providing our own code hosting on our servers.

Also see