ITK/Git/Develop

This page documents how to develop ITK through Git. See our table of contents for more information.

Git is an extremely powerful version control tool that supports many different "workflows" for indivudal development and collaboration. Here we document procedures used by the ITK development community. In the interest of simplicity and brevity we do not provide an explanation of why we use this approach. Furthermore, this is not a Git tutorial. Please see our Git resource links for third-party documentation, such as the ProGit Book.

Setup

Before you begin, perform initial setup:

1. Register Gerrit access and possibly Git push access
2. Optionally download our one page PDF desk reference
3. Follow the download instructions to create a local ITK clone
4. Run the developer setup script to prepare your ITK work tree and create Git command aliases used below:

$ ./Utilities/SetupForDevelopment.sh

Workflow

ITK development uses a branchy workflow based on topic branches. Our collaboration workflow consists of three main steps:

1. Local Development (requires no special access)
   • Update
   • Create a Topic
2. Code Review (requires Gerrit access)
   • Share a Topic
3. Integrate Changes (requires Git push access)
   • Merge a Topic
   • Delete a Topic

Update

Update your local master branch:
$ git checkout master $ git pullall	git help checkout (pullall is an alias for pull and submodule update)

Create a Topic

Name topics like you might name functions: concise but precise. A reader should have a general idea of the feature or fix to be developed given just the branch name.

To start a new topic branch:
$ git fetch origin $ git checkout -b my-topic origin/master	git help fetch git help checkout
Edit files and create commits (repeat as needed):
$ edit file1 file2 file3 $ git add file1 file2 file3 $ git commit	git help add git help commit

Share a Topic

Checkout the topic if it is not your current branch:
$ git checkout my-topic	git help checkout
Check what commits will be pushed to Gerrit for review:
$ git prepush	(prepush is an alias)
Push commits in your topic branch for review by the community:
$ git gerrit-push	(gerrit-push is an alias)

Merge a Topic

Checkout the topic if it is not your current branch:
$ git checkout my-topic	git help checkout
Push the topic to the ITK Topic Stage repository:
$ git stage-push	(stage-push is an alias)
Ask the topic stage repository to merge the topic:
$ git stage-merge	(stage-merge is an alias)

Delete a Topic

Checkout and update the master branch:
$ git checkout master $ git pullall	git help checkout (pullall is an alias for pull and submodule update)
Delete the local topic branch:
$ git branch -d my-topic	git help branch
The branch -d command works only when the topic branch has been correctly merged. Use -D instead of -d to force the deletion of an unmerged topic branch (warning - you could lose commits).