Documentation

How to contribute

Building from SourceIndexModule internal

Bugs or Features Request

All bugs and feature requests should go to our google issue tracker:

  1. Go to http://code.google.com/p/movid/issues/entry
  2. Fill in the title and content, and indicate the following things:
    1. Movid version (if it's git, indicate the last commit id)
    2. OS version
    3. OpenCV version
  3. Provide a stripped-down (i.e., minimal) test case to reproduce the problem.

Create a new module

If you want to contribute to Movid, you should know that:

  1. You don't need to have a commit access on our repository
  2. We'll merge your changes only when your work is clean (but don't be afraid, we will help!)

Get started

  1. Create or use your github account
  2. Go to http://github.com/tito/Movid
  3. Click on "Fork"
  4. Follow instruction on github about how to use your fork

Once you've cloned your fork onto your computer, you need to add us as a remote. Open a git console and type :

$ git remote add movid-master git://github.com/tito/Movid.git

Then, you have two ways to update your repository:

  1. push/pull on your repository as usual
  2. update your current branch from our repository

To update your branch from our repository, just type:

$ git pull movid-master master

Code code code

In your repository, you may create a new branch for each new module you want. If you intend to create a module "Calibration", you should create a branch named "movid-mod-calibration"

Never use the same branch for different modules.

(To make your module show up in the interface, it has to be added to the Makefile and the src/moFactory.cpp file at the appropriate positions. Try not to break the alphabetical order.)

When you're done with your module, you can ask us to pull your changes. It is important that we can talk to you during the review & merge process, so please stick around at least that long. Otherwise your module may not be merged due to missing communication!

Pull request

  1. In your fork on github, select the branch with your modifications
  2. Click on "Pull Request" and give a proper descriptions of what you changed/added/removed/fixed.
  3. Wait for us to review your code.
    1. After rewiewing your code, if we have questions, we'll write you a comment on github.
    2. If we are totally happy, your module will be included and your name will be listed as a contributor!