Skip to content

Adding new Extension

jandujar edited this page May 13, 2012 · 2 revisions

Thank you for your interest for contributing to cocos2d-x-extensions.
These guidelines will help you go down in history of cocos2d-x 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-x source: https://github.com/cocos2d/cocos2d-x
  3. Your extension should have examples, that shows all aspects of it and can be used as tests.

Preparing your Pull Request

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

  1. Switch to the latest 'bleeding edge' version of cocos2d-x-extensions:
    git clone https://github.com/jandujar/cocos2d-x-extensions
    cd cocos2d-x-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. From now on we think that your extension is CCAndroidCollider... God knows what is this thing for in cocos2d...
   git checkout -b CCAndroidCollider
  1. Apply your changes with detailed commit messages and comments.
  2. Push your branch to your fork of cocos2d-x-extensions. If you still don't have a fork of cocos2d-x-extensions - fork it: http://help.github.com/fork-a-repo/
  3. Send a pull request to develop branch: https://github.com/jandujar/cocos2d-x-extensions/pull/new

Adding an Extension

  1. Copy all files needed for work of your extension to the Extensions/Your_Extension folder including source & resource files, that user of your extension will need to include in his project.
  2. Copy all tests files of your extension to ExtensionsTests/Your_ExtensionTest including source & resource files. Resource files must be under ExtensionsTests/Resources
  3. Provide all necessary info about dependencies, system requirements, compatibility and issues in README file in Extensions/Your_Extension folder.

How can I contribute without worrying about all this git stuff?

Don't have time to learn GIT or register on GitHub? No problem!
You can just open a topic about your extension on the cocos2d-x forums: http://www.cocos2d-x.org/projects/cocos2d-x/boards/18