FRAT/Development: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Created page with "__NOTITLE__ __NOTOC__ {| border="1" cellpadding="10" cellspacing="0" |+ <p style="font-size:250%">(F)luid (R)egistration and (A)tlas (T)oolkit</p> |- | style="background:#efefef...")
 
Line 28: Line 28:
| align="left" width="800px" |  
| align="left" width="800px" |  
= Development Guidelines =
= Development Guidelines =
Current development on FRAT is done using [http://git-scm.com/ git]. The repository is currently hosted at:
* https://gitorious.org/frat
== Development Environment ==
== 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.


|-
|-
|}
|}

Revision as of 20:23, 10 August 2011

__NOTITLE__


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


Home




For Users




For Developers

  • Development Docs




Contact Us

Development Guidelines

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

Development Environment

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.