Contribute

Check list

Before entering a new report, you should query the current issue database for similar open issues. You might also want to talk about your issue by raising a question on Stackoverflow, as mentioned above. Eventually, make sure that you also consult the documentation section of the version of the Restlet Framework you are using.

Reporting an issue

The Restlet project relies on an issue tracker hosted at GitHub to manage all those reports. If you want to create a new report, you should first have a GitHub account. If necessary, you can create a new one by going to the signup page. Then you should go to the Issue Tracker page. If you don’t see the page to enter an issue, make sure that you are correctly logged into GitHub.

Submit contributions

If you found a bug and fixed it locally, or if you developed an enhancement that could benefit to others, you are welcome to submit your code changes. You simply need to follow these steps:

• Verify that your local Git repository builds and passes all the JUnit tests

• Consider writing additional unit tests covering your contribution

• Create a pull request on GitHub based on those instructions

• Once your patch is accepted, a signed Joint Copyright Assignment (JCA) will be required

Note

Note that the JCA is necessary in order to maintain a principal copyright holder for the whole code base and allow us to propose several open source licenses in parallel, to upgrade to future versions of those licenses or to choose new ones.

It also allows Restlet to offer restricted commercial licenses to other vendors or organizations wishing to incorporate and redistribute Restlet in their proprietary product without the constraints of our open source licenses or to develop custom versions without wanting to redistribute their changes publicly. In these case, it helps us to fund the ongoing development of our open source project.

For additional background on Contributor License Agreement, see this blog post from Julien Ponge.