Development guidelines

The following page includes guidelines for all developers wishing to expand this project:

File formatting

1. All files should contain the following header (with the relevant parts changed):

/**
 *
 * <class name> <class type> for the SourceKettle system
 * <description>
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 * 
 * @copyright     SourceKettle Development Team 2012
 * @link          http://github.com/SourceKettle/sourcekettle
 * @package       SourceKettle.<type>.<sub-type> (e.g. SourceKettle.View.Home)
 * @since         SourceKettle v 0.1
 * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

2. We are trying to adhere to the CakePHP formatting guidelines (they are fairly strict so give them a good read)

Git Branching model

1. We use GitFlow as a basis for commiting code and use this as a logical branching structure. We have 2 main branches:
   • Develop is for changes
   • Master is for scheduled releases which should be tagged with a version number
   • For New Features branch Develop to a new branch with the name 'feature/' and merge the branch with --no-ff when done
   • For Hot Fixes that are more than a simple commit, branch Develop to a new branch'hotfix/' and merge the branch with --no-ff when done