Thank you for contributing to this project.
We welcome bug reports and discussions about new function in the issue tracker, and we also welcome proposed new features or bug fixes via pull requests.
You should read these guidelines to help you contribute.
Please raise bugs via the issue tracker. First, check whether an issue for your problem already exists.
When raising bugs, try to give a good indication of the exact circumstances that provoked the bug. What were you doing? What did you expect to happen? What actually happened? What logs or other material can you provide to show the problem?
Please request new features via the issue tracker. When requesting features, try to show why you want the feature you're requesting.
If you're thinking of fixing a bug or adding new features, be sure to open an issue first. This gives us a place to have a discussion about the work.
All code must have an EPL v2.0 header. To save you the menial work of getting the header right, you can let the Maven build do so by using the add-licences profile:
mvn -Padd-licences process-sources
When you've run this, you'll find that new files have had headers added. Always check that you're happy with the changes this build has made.
You must declare that you wrote the code that you contribute, or that you have the right to contribute someone else's code. To do so, you must sign the Developer Certificate of Origin (DCO):
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
If you can certify the above, then sign off each Git commit at the bottom of the commit message with the following:
Signed-off-by: My Name <[email protected]>
You must use your real name and email address.
To save you having to type the above for every commit, Git can add the Signed-off-by line. When committing, add the -s option to your git commit command.
If you haven't signed each commit, then the pull request will fail to pass all checks.