Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 2.37 KB

README.md

File metadata and controls

83 lines (50 loc) · 2.37 KB
Raw

What is this project ?

This project is NOT the official SimpleITK repository.

It is a fork of SimpleITK sources hosted at https://github.com/SimpleITK/SimpleITK.

The official upstream repository is https://github.com/SimpleITK/SimpleITK.

It is used as staging area to maintain and test patches that will be contributed back to the official repository.

What is the branch naming convention ?

Each branch is named following the pattern slicer-vY.Y.Z-YYYY-MM-DD-SHA{7}

where:

  • vX.Y.Z is the version of the forked project
  • YYYY-MM-DD is the date of the last official commit associated with the branch.
  • SHA{7} are the first seven characters of the last official commit associated with the branch.

For more details, see https://www.slicer.org/wiki/Documentation/Nightly/Developers/ProjectForks

How to update the version of SimpleITK ?

  1. Clone this repository and add a remote to the official project
git clone git://github.com/Slicer/SimpleITK
cd SimpleITK
git remote add upstream git://github.com/SimpleITK/SimpleITK
git fetch upstream
  1. Create a new branch following the convention
# Extract version using git describe
XYZ=$(git describe --tags | cut -d"-" -f1)
echo "XYZ [${XYZ}]"

DATE=$(git show -s --format=%ci upstream/master | cut -d" " -f1)
echo "DATE [${DATE}]"

SHA=$(git show -s --format=%h upstream/master)
echo "SHA [${SHA}]"

BRANCH_NAME=slicer-v${XYZ}-${DATE}-${SHA}
echo "BRANCH_NAME [${BRANCH_NAME}]"

git checkout -b ${BRANCH_NAME} ${SHA}

  1. Cherry-pick the Slicer specific commits from last branch. Resolve conflict as needed.

  2. To test the changes, locally rebuild SimpleITK, ITK, CTK and Slicer.

  3. Publish the branch. (directly in this repo if you have push rights, or on a fork)

  4. Update Slicer SimpleITK external project and submit a pull request.

How to create a slicer- branch from a topic being contributed upstream ?

See https://www.slicer.org/wiki/Documentation/Nightly/Developers/ProjectForks#How_to_create_the_.22slicer-.22_branch_from_a_topic_being_contributed_upstream_.3F

How to be granted push rights ?

Ask on https://discourse.slicer.org/

Questions

If you have questions, see https://discourse.slicer.org/