Skip to content

Adding new Extension

psineur edited this page Jun 6, 2011 · 18 revisions

Thank you for your interest for contributing to cocos2d-iphone-extensions.
Cocos2D Community will never forget you!
These guidelines will help you go down in history of cocos2d community! ;)

Requirements

  1. Your extension should be licensed under MIT License: http://www.opensource.org/licenses/mit-license.php
  2. Your extension should be compatible with latest stable cocos2d source: https://github.com/cocos2d/cocos2d-iphone
  3. Your extension should have examples, that shows all aspects of it and can be used as tests.
  4. Try to follow cocos2d develop guidelines - this will increase your karma ;)

Preparing your Pull Request

You don't need to know Git & use GitHub to add your extension to the cocos2d-iphone-extensions repo.
But this is the best approach how to collaborate with us.

  1. Switch to the latest 'bleeding edge' version of cocos2d-iphone-extensions:
    git clone git@github.com:cocos2d/cocos2d-iphone-extensions.git
    cd cocos2d-iphone-extensions
    git fetch origin
    git checkout -t origin/develop
    git submodule update --init
  1. Create new branch from latest develop state with good describing name.
   git checkout -b CCAndroidCollider
  1. Apply your changes with detailed commit messages and comments. Don't forget that "person who will maintain your code is a maniac serial killer that knows where you live".
  2. Push your branch to your fork of cocos2d-iphone-extensions. If you still don't have a fork of cocos2d-iphone-extensions - fork it: http://help.github.com/fork-a-repo/
  3. Send a pull request to develop branch: https://github.com/cocos2d/cocos2d-iphone-extensions/pull/new

Adding an Extension

//TODO: do

Clone this wiki locally