Contribution Guide

Dependencies

We recommend using bundler to install all ruby dependencies, such as cocoapods.

bundle

Attribution and Copyright

All files MUST include the copyright header found in the repository: Copyright-Header.txt. Your help replacing any incorrect headers with this canonical one, as we propagate this requirement across the codebase, is greatly appreciated. We recommend the use of a code snippet with the abbreviation 'typhoon_header' to automate the insertion of this notice.

If you want, you can use a filter that will automatically check the header presence and include it if it is not already there for every file you add or modify. To enable this behaviour you should run this two commands in your working copy directory:

git config filter.typhoonheader.smudge 'cat'
git config filter.typhoonheader.clean '`git rev-parse --git-dir`/../Scripts/typhoonheader'

This two config entries register the filter that will add the right header for you.

Command-Line Build

Builds unit tests, integration tests and code coverage reports. Installs Typhoon documentation into Xcode.

Dependencies

We recommended installing CLI build dependencies using homebrew (http://brew.sh).

brew install ant

brew install lcov

brew install appledoc

brew install doxygen
brew install graphviz

NB: Xcode 4.3+ requires command-line tools to be installed separately.

Building

ant