Coding Guidelines

GIT Commits

• Commit messages are written in english
• Commits which are related to an issue BUT not closing it should include a referencing information in the commit message (e.g. Referencing #24)
• Commits which are closing an issue should include the fix issue information in the commit message (e.g. fixes #24)

Class and Function descriptions

We like to have a well documented code with the quick help functionality of XCode. Therefore every class and function should have a description in the following format.

/** 
Checks wether the current internet reachability is known (if not, start the check) and returns the current status.

- returns: String of current reachability status (`unknown`, `wifi`, `cellular`, `not_reachable`)

- author: Leo Käßner
*/

For more information see: https://developer.apple.com/library/ios/documentation/Xcode/Reference/xcode_markup_formatting_ref/index.html#//apple_ref/doc/uid/TP40016497-CH2-SW1