Git for dummies

From OpenEMR Project Wiki
Revision as of 07:57, 30 May 2010 by Bradymiller (talk | contribs)

Overview of Using git in OpenEMR

The goal of these instructions are to just get you started to use git in OpenEMR, and to avoid losing any of our valuable developers to suicide. Once you master the below information, then rather easy to at least get by and make patches.


Step 1: You too can have your very own public openemr repository on github.com!

1. Sign up for an account on github.com
2. Make a key, and put it in your gihthub.com account
3. Make a fork from the main openemr github repository at: http://github.com/openemr/openemr


Step 2: Now, set up your local repository

1. Install a git client on your local computer.
2. Clone your repository:
git clone git@github.com:yourRepositoryName/openemr.git openemr
  • (now your github repository is called 'origin')
3. Set up a connection to the main openemr respository:
git remote add upstream git://github.com/openemr/openemr.git
  • (now the main openemr github repository is called 'upstream')
4. All the pieces are now set up. You have your local repository that is connected to your public github repository(origin) and is connected to the official openemr github repository(upstream)


Step 3: Feeding your repository

1. The 'master' and 'rel-320' are sacred branches that should not be modified by mere mortals. Never ever manually modify these branches on your local or github repository(origin). These can only be feed by the official openemr github respository(upstream).
2. First, feed your local repository(from upstream):
git checkout master
git pull upstream master
git checkout rel-320
git pull upstream rel-320
  • (Now your local repository sacred branches are feed by most current official OpenEMR code)
3. Second, feed your github repository:
git push origin
  • (This command will feed your public github repository with updated code from your local repository; note there is no need to mention specific branches)
4. That's it. You now have the most current codebase in your local repository and your github public repository. I recommend repeating these steps frequently to keep your repositories well feed.


Tenet 1: Branches are gods

  • You may ask: If I can't work in the master or rel-320 branches, then where do I work in. The answer is your make new branches and put your work in there. Make a branch for every new project, bug fix, etc. To make a branch off of 'master' and go into it do the following:
git checkout master
git checkout -b newbranchname
  • Then do your work in this branch for your project. Recommend committing often via :
git commit -a
  • You can upload your branch to your public github repository via:
git push origin newbranchname
  • (Now others can see your branch and code, and can try it out)
  • You can also create an easy patch of your branch(ensure all changes have been committed)(I am assuming that the workbranchname was originally branched off master):
git format-patch master newbranchname
  • Another thing, always commit before moving to another branch.


Tenet 2: My custom branch and code is now out of date... time for rebase...

  • What happens to my custom branches as the master and rel-320 continue to get updated (via step 3 above)? Your patches and branches get out of date!!
  • This can be dealt by doing the following):
1. checkout your outdated branch:
git checkout workbranchname
2. rebase your outdated branch (I am assuming that the workbranchname was originally branched off master):
git rebase master
3. remove your outdated branch from your public git repository(origin):
git push origin :workbranchname
4. add your newly updated branch to your public git repository(origin):
git push origin workbranchname