Contribute

How to contribute

We believe that RESTx is the easiest way to create RESTful resources in your enterprise or in the cloud. But to make it the best it can be, we appreciate any help we can get.

Contacting us

There are several ways by which you can get in contact with us:
  • Send an email to juergen.brendel@mulesoft.com.
  • Visit the RESTx forum. If you want to post messages to the forum, please register, which is quick and easy.

Reporting a bug or request a feature

If you discover anything wrong with RESTx or find that an important feature is missing, please use our issue tracker to tell us about it. To file new tickets, please register.

Getting the source code

RESTx is free and open source software. Therefore, the sources are readily available, hosted on github. To get the sources, please issue this command:

git clone git://github.com/mulesoft/RESTx.git

This creates a RESTx directory in which you find all the sources and supporting file. Please note: After you downloaded the sources, you can also run the install.sh script to complete your setup. Your only prerequisite is that you have a full Java 6 JDK (including compiler). Once it is done, the installer prints out a summary of instructions for starting the server.

Compiling from source

RESTx comes with its own compile script. Most of the code is written in Python (running under Jython) and does not require compilation. The few necessary Java classes can be compiled with the following command:

bin/restcompile all

Creating and submitting patches

We gladly accept patches if you can find ways to improve, tune or fix RESTx in some way. RESTx is licensed under GPLv3, so you can be confident that your contributions remain public.

To create a patch, follow these steps. We are assuming here that you have downloaded the sources via git clone as described above and are now located in the RESTx directory.

  1. Create a new branch in which to make your changes. For example, the following command creates a new branch called 'my_fix' in which you can do your work: git checkout -b my_fix
  2. Edit and test the sources.
  3. Commit your changes into your branch, using git add and git commit.
  4. Create the patch file: git format-patch master --stdout > my_fix.patch

Then visit our issue tracker to file either file a new issue or identify an already existing issue, which this patch addresses. Please attach your patch file to the ticket and select Patch Submission as the issue type.

Thank you very much for your contribution!