FRAT/Development

From KitwarePublic
< FRAT
Revision as of 20:44, 10 August 2011 by Gabe.hart (talk | contribs)
Jump to navigationJump to search

__NOTITLE__


(F)luid (R)egistration and (A)tlas (T)oolkit


Home




For Users




For Developers




Contact Us

Development Guidelines

Current development on FRAT is done using git. The repository is currently hosted at:

Development Environment

To gain write access to the repository, contact one of the administrators. Once gained, follow the steps in the Installation Guide except use the read/write address to clone the repository

git clone git@gitorious.org:frat/frat.git

Workflow

Due to the small developer community, we follow a simple branchy workflow in git. The core workflow is:

  • To work on a new topic, create a branch off of master
git checkout master
git checkout -b MY_TOPIC
  • Work on the topic, making commits as necessary
<edit files>
git commit -a
<Add descriptive commit message>
  • Once the topic is complete, merge to master. NOTE: Please use "--no-ff" to force a merge commit. This keeps the master branch consistent as a series of topics being merged.
git checkout master
git merge --no-ff --log MY_TOPIC
  • Update the upstream repository
git push

NOTE: For minor bug fixes, commits directly onto master are ok. In this case, make sure that the commit message reads something like:

BUG: brief bug description

This is a full description of the bug and what I did to
fix it.