Skip to content

Submitting a Change

All change submissions must be handled through our Community Bulletin Board exclusively. Register to the bulletin board and submit your change in the appropriate section.

Before Submitting

Before you submit a change, we request you to have a prior look at our bulletin board to see if the topic was already raised or not. Use the search option of our board.

If the topic has already been addressed, check the status of the existing change proposal:

  • Rejected submissions may need additional work. Analyze the reason provided by the maintainer and check if you believe you can fix the issue. Always contact the original author of the submission before submitting your own modifications.
  • Pending submissions are either being reviewed by our maintainers or is on their to-do list. Please wait for the reviewing process. Do not submit changes to a pending submission but feel free to post comments that may help reviewer do their job (e.g. your own experience at reproducing the change).
  • Approved submissions will be incorporated in the next release of the project. If you believe you can improve on the approved change, wait that it appears in the next release before submitting a change of that version.

If the topic has not been addressed yet, consider the following before submitting your change:

  • does the change answer a real need or is it cosmetic only?
  • does the change reflect the state-of-the-art way of solving the problem?
  • what trade-off does the change imply?
  • do you have evidences to backup the claims of your change?

Submission

When you have performed all pre-submission checks, create a new thread on our bulletin board with the title formated as [CHANGE] Short Description. In the body of the message, describe your change in plain english as first paragraph. Then, give reviewers additional information they need to validate your change such as experimental results, screenshots, profiling data etc. Attach your change as a git diff patch to your message.

All submissions must include the line Submission made under the Developer's Certificate of Origin 1.1 which indicate your approval of our licensing scheme.

Reviewing

When your change has been submitted, one of our maintainer will review it to check if it fits into our submission guidelines. This process can take time, so please be patient. Never resubmit the same work under a new thread, as this will slow down the maintainers job.

Please note that maintainers are asked to systematicaly reject contributions that:

  • do not use the submission and/or licensing scheme,
  • are written in bad english or are too difficult to understand,
  • are done with a clear intend of self-promotion (individual or corporations),
  • are submited by agressive people.