Contributing to CTK

The present document aims at describing how a developer could efficiently contribute to CTK.

• The source code of CTK is currently hosted on Github [1]. See http://github.com/commonth/CTK

• It's also assumed the developer is familiar with git. There are countless amount of resources available online. A good start point could the list presented on CMake/git page [2].

• We use a topic-based workflow as documented here and thus define integration branches:
  • master Release preparation; starting point for new features (default)
  • next Development; new features published here first

PreRequisites

• Create an account on github.com
• Fork http://github.com/commontk/CTK
• Introduce yourself

$ git config --global user.name "Your Name"
$ git config --global user.email "you@yourdomain.com"

Checkout your fork

cd MyProject
git clone git@github.com:<MYACCOUNT>/CTK.git
git remote add origin git@github.com:<MYACCOUNT>/CTK.git
git remote add upstream git@github.com/commontk/CTK.git

Publishing your branch

• Having your own fork CTK allows you to backup and publish your work avoiding the hurge to merge[3]

git checkout -b new_feature
hack, hack, hack, add, commit
git push origin topic1:refs/heads/topic1

• As a shortcut, you could enter the following:

git config branch.topic1.remote origin
git config branch.topic1.merge refs/heads/topic1

• Then, from the branch new_feature, you could just enter the following to backup your work:

git push