Developer Resources

This project is a community effort, and everyone is welcomed to contribute.

Submitting an Issue

In case you experience difficulties using the package, do not hesitate to create a issue. You are also welcomed to post there feature requests and patches.

Retrieving the Latest Code

You can check the latest sources with the command:

$ git clone https://github.com/muricoca/crab.git

Contributing Code

How to contribute

The prefered way to contribute to Crab is to fork the main repository on github:

$ git clone https://github.com/muricoca/crab.git

Create an account on github if you don’t have one already.

Fork the https://github.com/muricoca/crab.git repo: click on the ‘Fork’ button, at the top, center of the page. This creates a copy of the code on the github server where you can work.

Clone this copy to your local disk (you need the git program to do this):

$ git clone https://github.com/muricoca/crab.git

Work on this copy, on your computer, using git to do the version control:

$ git add modified_files

$ git commit

$ git push origin master

and so on.

When you are ready, and you have pushed your changes on your github repo, go the web page of the repo, and click on ‘Pull request’ to send us a pull request. Send us a mail with your pull request, and we can look at your changes, and integrate them. (E-mail to [email protected])

Before asking for a pull or a review, be sure to read the coding-guidelines at our wiki page.

Also, make sure that your code is tested, and that all the tests for the Crab pass.

EasyFix Issues

The best way to get your feet wet is to pick up an issue from the issue tracker that are labeled as Easy Fix. This means that the knowledge needed to solve the issue is low, but still you are helping the project and letting more experienced developers concentrate on other issues.