Coding Guidelines

If you are submitting code, please have a look at the Coding Guidelines page .

Please keep some things in mind when preparing your patches for submission:

Generating Patches

Generating patches depends on the method you used to get the source code.

Methods for Submitting Patches

Submitting changes can happen in one of three methods:

Using the Mob Branch

The public git repository service at repo.or.cz provides an interesting feature, which allows anyone to push to a "mob" branch of a repository, if so configured by the admin.

It would go something like this:

        # clone with mob user
        git clone git+ssh://mob@repo.or.cz/srv/git/barry.git barry

        cd barry
        git checkout -b mob origin/mob
        git diff origin/master..mob             # make sure master == mob
        <make changes>
        git add ... && git commit
        git push origin mob
        <send email to the list, include the SHA1 sum of the commit>

This is a novel idea, as well as a security risk for anyone who blindly runs whatever is in the mob branch. Hence the recommended diff check above, to make sure you're working on an official branch.

The mob user can only push to the mob branch, so all other branches are read-only, and have been reviewed at least once by the project maintainer.

But the mob branch frees people up to use git, who may not have their own hosting, or who may not want to bother setting up their own git repo. People can use it to collaborate on a feature as well. Let your imagination run wild.

You can read more about the ideas behind the mob branch at the repo.or.cz mob page