FRAT/Development: Difference between revisions
From KitwarePublic
< FRAT
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...") |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 14: | Line 14: | ||
<br> | <br> | ||
<b>For Users</b> | <b>For Users</b> | ||
* [[FRAT/ | * [[FRAT/Install_Guide | Installation Guide]] | ||
* [[FRAT/Slicer | FRAT with Slicer]] | * [[FRAT/Slicer | FRAT with Slicer]] | ||
<br> | <br> | ||
| Line 20: | Line 20: | ||
<br> | <br> | ||
<b>For Developers</b> | <b>For Developers</b> | ||
* Development Docs | * [[FRAT/Library | libFRAT]] | ||
* [[FRAT/Documentation | API Documentation]] | |||
* [[FRAT/Development | Development Docs]] | |||
<br> | <br> | ||
<hr> | <hr> | ||
| Line 28: | Line 30: | ||
| 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/frat | |||
== Development Environment == | |||
To gain write access to the repository, contact one of the [[FRAT/Team | administrators]]. Once gained, follow the steps in the [[FRAT/Install_Guide | 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. | |||
|- | |- | ||
|} | |} | ||
Latest revision as of 22:17, 11 August 2011
__NOTITLE__
|
|
Development GuidelinesCurrent development on FRAT is done using git. The repository is currently hosted at: Development EnvironmentTo 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 WorkflowDue to the small developer community, we follow a simple branchy workflow in git. The core workflow is:
git checkout master git checkout -b MY_TOPIC
<edit files> git commit -a <Add descriptive commit message>
git checkout master git merge --no-ff --log MY_TOPIC
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. |
