Skip to content

Contributing code to StitchIt

Rob Campbell edited this page Mar 11, 2017 · 12 revisions

Contributions to StitchIt are welcome.

  • Ideally you should fork the repository and send contributions as a pull request. StitchIt tends to be updated regularly, so keep your fork up to date or it will become difficult to merge your changes.
  • New functions you add should have full help text e.g. like stitchSection.m
  • If you modify the arguments in an existing function you should also update the function's help text.
  • Many small commits are better than single big ones.
  • Keep your pull requests clean. e.g. do not include commented-out test code code, temporary functions, or highly specialised functions such as stitchSection_BobsVersion.m. That includes adding your INI files or your post-acquisition functions. Such pull requests won't be accepted.
  • Ideally use spaces instead of tabs for indenting.
  • Read the developer notes

The dev branch

I try to keep the number of commits on the master branch low and I try not commit things that might break stuff to the master branch. Non-trivial changes therefore are made in the dev branch as follows:

  • Merge the master branch into dev and check out dev.
  • Commit changes to dev.
  • Test.
  • Merge dev back into master with a merge-commit to keep things neat in the master branch.
  • List changes in the changelog. (this last step is new)